You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ha...@apache.org on 2021/03/29 05:38:06 UTC
[skywalking-banyandb] 01/02: fist commit
This is an automated email from the ASF dual-hosted git repository.
hanahmily pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
commit ce3d04eb919af8d7a22d0b8add29c10154568e68
Author: Gao Hongtao <ha...@gmail.com>
AuthorDate: Mon Mar 29 13:31:48 2021 +0800
fist commit
---
.gitignore | 31 ++++++
CHANGES.md | 36 +++++++
CONTRIBUTING.md | 81 +++++++++++++++
LICENSE | 201 ++++++++++++++++++++++++++++++++++++++
NOTICE | 5 +
README.md | 54 ++++++++++
assets/banyandb.jpeg | Bin 0 -> 53283 bytes
assets/banyandb_small.jpg | Bin 0 -> 41406 bytes
go.mod | 3 +
golangci.yml | 54 ++++++++++
standalone/cmd/standalone/main.go | 1 +
standalone/internal/cmd/root.go | 1 +
12 files changed, 467 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0fb1992
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,31 @@
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin
+build/bin
+build/release/
+apiserver.local*
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Kubernetes Generated files - skip generated files, except for vendored files
+
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+*.swp
+*.swo
+*~
+.vscode
+
+.DS_Store
+.env
diff --git a/CHANGES.md b/CHANGES.md
new file mode 100644
index 0000000..695cc65
--- /dev/null
+++ b/CHANGES.md
@@ -0,0 +1,36 @@
+Changes by Version
+==================
+Release Notes.
+
+0.3.0
+------------------
+
+#### Features
+- Support special characters in the metric selector of HPA metric adapter.
+- Add the namespace to HPA metric name.
+
+#### Chores
+- Upgrade skywalking-cli dependency.
+
+0.2.0
+------------------
+
+#### Features
+- Introduce custom metrics adapter to SkyWalking OAP cluster for Kubernetes HPA autoscaling.
+- Add RBAC files and service account to support Kubernetes coordination.
+- Add default and validation webhooks to operator controllers.
+- Add UI CRD to deploy skywalking UI server.
+- Add Fetcher CRD to fetch metrics from other telemetry system, for example, Prometheus.
+
+#### Chores
+- Transform project layers to support multiple applications.
+- Introduce unit test to verify the operator.
+
+0.1.0
+------------------
+
+#### Features
+- Add OAPServer CRDs and controller.
+
+#### Chores
+- Set up GitHub actions to build from sources, check code styles, licenses.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..cc1802c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,81 @@
+# Contributing to Apache SkyWalking Cloud on Kubernetes
+
+Firstly, thanks for your interest in contributing! We hope that this will be a
+pleasant first experience for you, and that you will return to continue
+contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Apache
+software Foundation's [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html).
+By participating, you are expected to adhere to this code. If you are aware of unacceptable behavior, please visit the
+[Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
+and follow the instructions there.
+
+## How to contribute?
+
+Most of the contributions that we receive are code contributions, but you can
+also contribute to the documentation or simply report solid bugs
+for us to fix.
+
+## How to report a bug?
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/skywalking/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
+Be sure to include a **title and clear description**, as much relevant information as possible,
+and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## How to add a new feature or change an existing one
+
+_Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._
+Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
+
+Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
+
+* Update the README.md with details of changes to the interface.
+* Includes tests for new functionality.
+* References the original issue in description, e.g. "Resolves #123".
+* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Compiling and building
+Clone the source code and simply run `make` in the source directory,
+this will download all necessary dependencies and run tests, lint, and build three binary files in `./bin/`, for Windows, Linux, MacOS respectively.
+
+```shell
+make
+```
+
+## Linting your codes
+We have some rules for the code style and please lint your codes locally before opening a pull request
+
+```shell
+make lint
+```
+
+if you found some errors in the output of the above command, try `make format` to fix some obvious style issues, as for the complicated errors, please fix them manually.
+
+## Checking license
+The Apache Software Foundation requires every source file to contain a license header, run `make license` to check that there is license header in every source file.
+
+```shell
+make license
+```
+
+## How to release
+This section guides committers and PMC members to release SkyWalking Cloud on Kubernetes in Apache Way.
+
+### Prerequisites
+- [x] [GNU Make](https://www.gnu.org/software/make/manual/make.html) is installed
+- [x] [GPG tool](https://gpgtools.org) is installed
+- [x] [Add your GPG key](docs/release.md#add-your-gpg-public-key)
+
+### Release steps
+- Export the version that is to be released, `export VERSION=0.1.0 `
+- Tag the latest commit that is to be released with `git tag ${VERSION}` and push the tag with `git push https://github.com/apache/skywalking-swck ${VERSION}`
+- Verify licenses, build and sign distribution packages, simply run `make release`, distribution packages and checksums are generated
+- [Upload the packages to SVN repository](docs/release.md#upload-to-apache-svn)
+- [Send internal announcement](docs/release.md#make-the-internal-announcements)
+- [Wait at least 48 hours for test responses](docs/release.md#wait-at-least-48-hours-for-test-responses)
+- [Call for vote](docs/release.md#call-a-vote-in-dev)
+- [Publish release](docs/release.md#publish-release)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..79342a6
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..e646f51
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,5 @@
+Apache SkyWalking
+Copyright 2017-2020 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c9f416
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+Apache SkyWalking Cloud on Kubernetes
+============
+
+
+
+<img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" />
+
+A bridge project between [Apache SkyWalking](https://github.com/apache/skywalking) and Kubernetes.
+
+SWCK is a platform for the SkyWalking user, provisions, upgrades, maintains SkyWalking relevant components, and makes them work natively on Kubernetes.
+
+# Features
+
+ 1. Operator: Provision and maintain SkyWalking backend components.
+ 1. Custom Metrics Adapter: Provides custom metrics come from SkyWalking OAP cluster for autoscaling by Kubernetes HPA
+
+# Quick Start
+
+ * Go to the [download page](https://skywalking.apache.org/downloads/) to download latest release manifest.
+
+## Operator
+
+ * To install the operator in an existing cluster, make sure you have [`cert-manager` installed](https://cert-manager.io/docs/installation/)
+ * Apply the manifests for the Controller and CRDs in release/config:
+
+ ```
+ kubectl apply -f release/operator/config
+ ```
+
+For more details, please refer to [deploy operator](docs/operator.md)
+
+### Examples of the Operator
+
+There are some instant examples to represent the functions or features of the Operator.
+
+ - [Deploy OAP server and UI with default settings](./docs/examples/default-backend.md)
+ - [Fetch metrics from the Istio control plane(istiod)](./docs/examples/istio-controlplane.md)
+
+## Custom Metrics Adapter
+
+ * Deploy OAP server by referring to Operator Quick Start.
+ * Apply the manifests for an adapter in release/adapter/config:
+
+ ```
+ kubectl apply -f release/adapter/config
+ ```
+
+For more details, please read [Custom metrics adapter](docs/custom-metrics-adapter.md)
+
+# Contributing
+For developers who want to contribute to this project, see [Contribution Guide](CONTRIBUTING.md)
+
+# License
+[Apache 2.0 License.](/LICENSE)
diff --git a/assets/banyandb.jpeg b/assets/banyandb.jpeg
new file mode 100644
index 0000000..ea4db3b
Binary files /dev/null and b/assets/banyandb.jpeg differ
diff --git a/assets/banyandb_small.jpg b/assets/banyandb_small.jpg
new file mode 100644
index 0000000..ee9d7c2
Binary files /dev/null and b/assets/banyandb_small.jpg differ
diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..ef6a243
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,3 @@
+module github.com/apache/skywalking-banyandb
+
+go 1.16
diff --git a/golangci.yml b/golangci.yml
new file mode 100644
index 0000000..2f43dd7
--- /dev/null
+++ b/golangci.yml
@@ -0,0 +1,54 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+linters:
+ enable:
+ - deadcode
+ - errcheck
+ - goconst
+ - golint
+ - ineffassign
+ - lll
+ - maligned
+ - misspell
+ - structcheck
+ - unconvert
+ - varcheck
+ - govet
+ - goimports
+ - prealloc
+ - unused
+ - staticcheck
+ - gosimple
+ - megacheck
+ disable:
+ - interfacer
+linters-settings:
+ lll:
+ line-length: 170
+ goconst:
+ min-occurrences: 4
+ govet:
+ check-shadowing: true
+run:
+ deadline: 10m
+ skip-dirs:
+ - config
+ - docs
+issues:
+ exclude:
+ # staticcheck
+ - 'SA1019: Package github.com/golang/protobuf/proto is deprecated: Use the "google.golang.org/protobuf/proto" package instead.'
+ - 'SA1019: Package github.com/golang/protobuf/jsonpb is deprecated: Use the "google.golang.org/protobuf/encoding/protojson" package instead.'
diff --git a/standalone/cmd/standalone/main.go b/standalone/cmd/standalone/main.go
new file mode 100644
index 0000000..534183f
--- /dev/null
+++ b/standalone/cmd/standalone/main.go
@@ -0,0 +1 @@
+package standalone
diff --git a/standalone/internal/cmd/root.go b/standalone/internal/cmd/root.go
new file mode 100644
index 0000000..1d619dd
--- /dev/null
+++ b/standalone/internal/cmd/root.go
@@ -0,0 +1 @@
+package cmd