diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..2561e78 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# These owners will be the default owners for everything in the repo. +* @go-vela/admins diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7e8fc6a --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at +[TTS-OpenSource-Office@target.com](mailto:TTS-OpenSource-Office@target.com). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..92e0a4a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,79 @@ +# Contributing + +We'd love to accept your contributions to this project! There are just a few guidelines you need to follow. + +## Feature Requests + +Feature Requests should be opened up as [Issues](/issues/new/) on this repository! + +## Issues + +[Issues](/issues/new/) are always welcome! + +## Pull Requests + +**NOTE: We recommend you start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on.** + +We are always welcome to new PRs! You can follow the below guide for learning how you can contribute to the project! + +## Getting Started + +### Prerequisites + +* [Review the commit guide we follow](https://chris.beams.io/posts/git-commit/#seven-rules) - ensure your commits follow our standards +* [Docker](https://docs.docker.com/install/) - building block for local development +* [Docker Compose](https://docs.docker.com/compose/install/) - start up local development +* [Golang](https://golang.org/dl/) - for source code and [dependency management](https://github.com/golang/go/wiki/Modules) +* [Make](https://www.gnu.org/software/make/) - start up local development + +### Setup + +* [Fork](/fork) this repository + +* Clone this repository to your workstation: + +```bash +# Clone the project +git clone git@github.com:go-vela/vela-kubernetes.git $HOME/go-vela/vela-kubernetes +``` + +* Navigate to the repository code: + +```bash +# Change into the project directory +cd $HOME/go-vela/vela-kubernetes +``` + +* Point the original code at your fork: + +```bash +# Add a remote branch pointing to your fork +git remote add fork https://github.com/your_fork/vela-kubernetes +``` + +### Running Locally + +* Navigate to the repository code: + +```bash +# Change into the project directory +cd $HOME/go-vela/vela-kubernetes +``` + +* Build the repository code: + +```bash +# Build the code with `make` +make build +``` + +* Run the repository code: + +```bash +# Run the code with `make` +make run +``` + +### Development + +coming soon! diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..5a2dd55 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,33 @@ +# vela-kubernetes + +[![GoDoc](https://godoc.org/github.com/go-vela/vela-kubernetes?status.svg)](https://godoc.org/github.com/go-vela/vela-kubernetes) +[![Go Report Card](https://goreportcard.com/badge/go-vela/vela-kubernetes)](https://goreportcard.com/report/go-vela/vela-kubernetes) +[![codecov](https://codecov.io/gh/go-vela/vela-kubernetes/branch/master/graph/badge.svg)](https://codecov.io/gh/go-vela/vela-kubernetes) + +Vela plugin designed for managing resources in [Kubernetes](https://kubernetes.io/). + +Internally, the plugin is a wrapper around the [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) CLI. + +## Documentation + +For installation and usage, please [visit our docs](https://go-vela.github.io/docs). + +## Contributing + +We are always welcome to new pull requests! + +Please see our [contributing](CONTRIBUTING.md) docs for further instructions. + +## Support + +We are always here to help! + +Please see our [support](SUPPORT.md) documentation for further instructions. + +## Copyright and License + +``` +Copyright (c) 2020 Target Brands, Inc. +``` + +[![license](https://img.shields.io/crates/l/gl.svg)](LICENSE) diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..75826d5 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,15 @@ +# Support + +Welcome to Vela! To get help with a specific aspect of Vela, we've provided the below information. + +## Bugs or Feature Requests + +We use GitHub for tracking bugs and feature requests. + +Please see our [contributing](CONTRIBUTING.md) documentation for further instructions. + +## Questions + +We use Slack for supporting questions not already covered in the above documents. + +Please join the [#vela](https://gophers.slack.com/app_redirect?channel=CNRRKE8KY) channel. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8bc8c22 --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +# Created by https://www.gitignore.io/api/go + +### Go ### +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +### Go Patch ### +/vendor/ +/Godeps/ + + +# End of https://www.gitignore.io/api/go + +# Binary release folder +release/ + +# IntelliJ project folder +.idea/ + +# IntelliJ project files +*.iml +*.ipr +*.iws +*.xml diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..433ad3d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,37 @@ +# Copyright (c) 2020 Target Brands, Inc. All rights reserved. +# +# Use of this source code is governed by the LICENSE file in this repository. + +############################################################################### +## docker build --no-cache --target binary -t vela-kubernetes:binary . ## +############################################################################### + +FROM alpine as binary + +ARG KUBECTL_VERSION=v1.17.0 + +ADD https://storage.googleapis.com/kubernetes-release/release/${KUBECTL_VERSION}/bin/linux/amd64/kubectl /bin/kubectl + +RUN chmod a+x /bin/kubectl + +############################################################################# +## docker build --no-cache --target certs -t vela-kubernetes:certs . ## +############################################################################# + +FROM alpine as certs + +RUN apk add --update --no-cache ca-certificates + +############################################################## +## docker build --no-cache -t vela-kubernetes:local . ## +############################################################## + +FROM scratch + +COPY --from=binary /bin/kubectl /bin/kubectl + +COPY --from=certs /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt + +COPY release/vela-kubernetes /bin/vela-kubernetes + +ENTRYPOINT [ "/bin/vela-kubernetes" ] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1108a52 --- /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 (c) 2020 Target Brands, Inc. + + 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/Makefile b/Makefile new file mode 100644 index 0000000..74020eb --- /dev/null +++ b/Makefile @@ -0,0 +1,50 @@ +# Copyright (c) 2020 Target Brands, Inc. All rights reserved. +# +# Use of this source code is governed by the LICENSE file in this repository. + +build: binary-build + +run: build docker-build docker-run + +test: build docker-build docker-example + +################################# +###### Go clean ###### +################################# + +clean: + + @go mod tidy + @go vet ./... + @go fmt ./... + @echo "I'm kind of the only name in clean energy right now" + +################################# +###### Build Binary ###### +################################# + +binary-build: + + GOOS=linux CGO_ENABLED=0 go build -o release/vela-kubernetes github.com/go-vela/vela-kubernetes/cmd/vela-kubernetes + +################################# +###### Docker Build ###### +################################# + +docker-build: + + docker build --no-cache -t vela-kubernetes:local . + +################################# +###### Docker Run ###### +################################# + +docker-run: + + docker run --rm \ + vela-kubernetes:local + +docker-example: + + docker run --rm \ + vela-kubernetes:local diff --git a/README.md b/README.md deleted file mode 100644 index 789fd9d..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# vela-kubernetes -Kubernetes Plugin for Vela (Target's official Pipeline Automation Framework) diff --git a/cmd/vela-kubernetes/main.go b/cmd/vela-kubernetes/main.go new file mode 100644 index 0000000..3ae1725 --- /dev/null +++ b/cmd/vela-kubernetes/main.go @@ -0,0 +1,86 @@ +// Copyright (c) 2020 Target Brands, Inc. All rights reserved. +// +// Use of this source code is governed by the LICENSE file in this repository. + +package main + +import ( + "os" + + "time" + + "github.com/sirupsen/logrus" + "github.com/urfave/cli" + + _ "github.com/joho/godotenv/autoload" +) + +func main() { + app := cli.NewApp() + + // Plugin Information + + app.Name = "vela-kubernetes" + app.HelpName = "vela-kubernetes" + app.Usage = "Vela Kubernetes plugin for managing Kubernetes resources" + app.Copyright = "Copyright (c) 2020 Target Brands, Inc. All rights reserved." + app.Authors = []cli.Author{ + { + Name: "Vela Admins", + Email: "vela@target.com", + }, + } + + // Plugin Metadata + + app.Compiled = time.Now() + app.Action = run + + // Plugin Flags + + app.Flags = []cli.Flag{ + + cli.StringFlag{ + EnvVar: "PARAMETER_LOG_LEVEL,VELA_LOG_LEVEL,KUBERNETES_LOG_LEVEL", + Name: "log.level", + Usage: "set log level - options: (trace|debug|info|warn|error|fatal|panic)", + Value: "info", + }, + } + + err := app.Run(os.Args) + if err != nil { + logrus.Fatal(err) + } +} + +// run executes the plugin based off the configuration provided. +func run(c *cli.Context) error { + // set the log level for the plugin + switch c.String("log.level") { + case "t", "trace", "Trace", "TRACE": + logrus.SetLevel(logrus.TraceLevel) + case "d", "debug", "Debug", "DEBUG": + logrus.SetLevel(logrus.DebugLevel) + case "w", "warn", "Warn", "WARN": + logrus.SetLevel(logrus.WarnLevel) + case "e", "error", "Error", "ERROR": + logrus.SetLevel(logrus.ErrorLevel) + case "f", "fatal", "Fatal", "FATAL": + logrus.SetLevel(logrus.FatalLevel) + case "p", "panic", "Panic", "PANIC": + logrus.SetLevel(logrus.PanicLevel) + case "i", "info", "Info", "INFO": + fallthrough + default: + logrus.SetLevel(logrus.InfoLevel) + } + + logrus.WithFields(logrus.Fields{ + "code": "https://github.com/go-vela/vela-kubernetes", + "docs": "https://go-vela.github.io/docs/plugins/registry/kubernetes", + "time": time.Now(), + }).Info("Vela Kubernetes Plugin") + + return nil +}