From 950d7698f0f31dfade8238ec46e416e997730b97 Mon Sep 17 00:00:00 2001 From: Jerome Ju Date: Thu, 28 Mar 2024 11:52:52 -0400 Subject: [PATCH 1/2] feat: init deploy-gke Container Action This commit inits the deploy-gke container action. It utlizes the gke-deploy CLI image to deploy an existing image to a GKE cluster. The integration test, documentation and CI setup are included within this initial commit. --- .github/dependabot.yml | 24 ++++ .github/workflows/draft-release.yml | 38 ++++++ .github/workflows/integration.yml | 71 ++++++++++ .github/workflows/release.yml | 27 ++++ .gitignore | 1 + CHANGELOG.md | 4 + CODEOWNERS | 1 + Dockerfile | 21 +++ LICENSE | 202 ++++++++++++++++++++++++++++ action.yml | 72 ++++++++++ entrypoint.sh | 47 +++++++ 11 files changed, 508 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/draft-release.yml create mode 100644 .github/workflows/integration.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODEOWNERS create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 action.yml create mode 100755 entrypoint.sh diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..07de5dd --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,24 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +version: 2 +updates: + - package-ecosystem: 'npm' + directory: '/' + rebase-strategy: 'disabled' + schedule: + interval: 'daily' + commit-message: + prefix: 'security: ' + open-pull-requests-limit: 0 # only check security updates diff --git a/.github/workflows/draft-release.yml b/.github/workflows/draft-release.yml new file mode 100644 index 0000000..0dc22fd --- /dev/null +++ b/.github/workflows/draft-release.yml @@ -0,0 +1,38 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +name: 'Draft release' + +on: + workflow_dispatch: + inputs: + version_strategy: + description: 'Version strategy: The strategy to used to update the version based on semantic versioning (more info at https://semver.org/).' + required: true + default: 'patch' + type: 'choice' + options: + - 'major' + - 'minor' + - 'patch' + +jobs: + draft-release: + name: 'Draft release' + uses: 'google-github-actions/.github/.github/workflows/draft-release.yml@v0' + with: + version_strategy: '${{ github.event.inputs.version_strategy }}' + # secrets must be explicitly passed to reusable workflows https://docs.github.com/en/enterprise-cloud@latest/actions/using-workflows/reusing-workflows#using-inputs-and-secrets-in-a-reusable-workflow + secrets: + ACTIONS_BOT_TOKEN: '${{ secrets.ACTIONS_BOT_TOKEN }}' diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml new file mode 100644 index 0000000..729b286 --- /dev/null +++ b/.github/workflows/integration.yml @@ -0,0 +1,71 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +name: 'Integration' + +on: + push: + branches: + - 'main' + - 'release/**/*' + pull_request: + branches: + - 'main' + - 'release/**/*' + workflow_dispatch: + +concurrency: + group: '${{ github.workflow }}-${{ github.head_ref || github.ref }}' + cancel-in-progress: true + +permissions: + contents: 'read' + id-token: 'write' + +jobs: + integration: + if: ${{ github.event_name == 'push' || github.repository == github.event.pull_request.head.repo.full_name && github.actor != 'dependabot[bot]' }} + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/checkout@v4' + + - uses: 'google-github-actions/auth@v2' + with: + workload_identity_provider: '${{ vars.WIF_PROVIDER_NAME }}' + + # The existing gke-deploy CLI will succeed or fail with logs with troubleshooting logs + # Please refer to https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gke-deploy + # for more information. + - name: 'deploy-gke' + uses: './' + with: + image: '${{ vars.IMAGE }}' + app_name: '${{ vars.APP_NAME }}' + region: '${{ vars.CLUSTER_REGION }}' + cluster_name: '${{ vars.CLUSTER_NAME }}' + project_id: '${{ vars.PROJECT_ID }}' + namespace: '${{ vars.NAMESPACE }}' + expose: '${{ vars.EXPOSE }}' + + - name: 'get credentials' + uses: 'google-github-actions/get-gke-credentials@v2' + with: + cluster_name: '${{ vars.CLUSTER_NAME }}' + location: '${{ vars.CLUSTER_REGION }}' + project_id: '${{ vars.PROJECT_ID }}' + + - name: 'get-deployment' + shell: bash + run: | + kubectl get deployment -n ${{ vars.NAMESPACE }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..2282a78 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,27 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +name: 'Release' + +on: + push: + branches: + - 'main' + - 'release/**/*' + +jobs: + release: + if: "startsWith(github.event.head_commit.message, 'Release: v')" + name: 'Release' + uses: 'google-github-actions/.github/.github/workflows/release.yml@v0' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8e96122 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +runner/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4e05c40 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Changelog + +Changelogs for each release are located on the [releases page](https://github.com/google-github-actions/deploy-gke/releases). + diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..2d87429 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @google-github-actions/maintainers \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..e0247fd --- /dev/null +++ b/Dockerfile @@ -0,0 +1,21 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +FROM us-docker.pkg.dev/gcb-catalog-release/preview/gke-deploy@sha256:a85701dedd45e7c3995a09cce83ec307a591525b782038dcd5cf7c2811464cb7 as gke-deploy + +USER root + +COPY entrypoint.sh /entrypoint.sh + +ENTRYPOINT ["/entrypoint.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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/action.yml b/action.yml new file mode 100644 index 0000000..e358878 --- /dev/null +++ b/action.yml @@ -0,0 +1,72 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +name: Deploy GKE +description: |- + Use gke-deploy cli to deploy an image +author: Google LLC + +inputs: + image: + description: |- + Image to be deployed + required: true + + app_name: + description: |- + Application name of the Kubernetes deployment + required: true + + region: + description: |- + Region/zone of GKE cluster to deploy to. + required: true + + cluster_name: + description: |- + Name of GKE cluster to deploy to. + required: true + + project_id: + description: |- + Project of GKE cluster to deploy to. + required: true + + namespace: + description: |- + Namespace of GKE cluster to deploy to. + If not provided, it will not be passed to the binary. + required: false + + expose: + description: |- + The port provided will be used to expose the deployed workload object (i.e., port and targetPort will be set to the value provided in this flag). + If not provided, it will not be passed to the binary. + required: false + +branding: + icon: 'lock' + color: 'blue' + +runs: + using: 'docker' + image: 'Dockerfile' + args: + - ${{ inputs.image }} + - ${{ inputs.app_name }} + - ${{ inputs.region }} + - ${{ inputs.cluster_name }} + - ${{ inputs.project_id }} + - ${{ inputs.namespace }} + - ${{ inputs.expose }} diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..2fa29c1 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,47 @@ +# Copyright 2024 Google LLC +# +# 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 +# +# https://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. + +#!/bin/sh -l + +gha_version="0.1.0" +gke_deploy_command="gke-deploy run -i $image -a $app_name -l $location -c $cluster_name -p $project_id" + +image="$1" +app_name="$2" +location="$3" +cluster_name="$4" +project_id="$5" +namespace="$6" +expose_port="$7" + +# Ensure all required variables are provided by workflow users. +if [ -z "$image" ] || [ -z "$app_name" ] || [ -z "$location" ] || [ -z "$cluster_name" ] || [ -z "$project_id" ]; then + echo "Error: Required variables (image, app_name, location, cluster_name, project_id) are not set." + exit 1 +fi + +# Add namespace if the input is apparent. +if [ -n "$namespace" ]; then + gke_deploy_command="$gke_deploy_command -n $namespace" +fi + +# Add expose port if the input is apparent. +if [ -n "$expose_port" ]; then + gke_deploy_command="$gke_deploy_command -x $expose_port" +fi + +# Utilize Google APIs user agent for metrics with the following unique identifier: +export GOOGLE_APIS_USER_AGENT=google-github-action:deploy-gke/$gha_version + +$gke_deploy_command From ba3a0a39c669020f379a29f75d4d8dfc93f6b82a Mon Sep 17 00:00:00 2001 From: Jerome Ju Date: Thu, 28 Mar 2024 14:46:57 -0400 Subject: [PATCH 2/2] Add CONTRIBUTING Markdown file --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ace3f9c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to Google GitHub Actions + +We will review and may accept contributions to all repositories in +[google-github-actions][org]. Below are some guidelines to maximize your +contribution. + +**Please note:** This project is not an officially supported Google product. It +is not covered by a Google Cloud support contract. To report bugs or request +features in the Google Cloud product, please [contact Google Cloud +support](https://cloud.google.com/support). + + +## Contributor License Agreement + +Contributions to this project must be accompanied by a Google Contributor +License Agreement (CLA). You (or your employer) retain the copyright to your +contribution, but the CLA gives us permission to use and redistribute your +contributions as part of the project. + +Visit the [Google Developers CLA Portal](https://cla.developers.google.com/) to +sign the agreement. You generally only need to sign the CLA once for all Google +projects. + +**If you do not sign the Google CLA, we are unable to merge your contribution.** + + +## Code of Conduct + +All contributions must follow our [Code of Conduct][coc]. We will reject +contributions which violate the Code of Conduct, regardless of their technical +merit. + + +## Development Model + +We develop using Git's branching model. To propose a contribution: + +1. [Fork][fork] the repository. + +1. [Clone][clone] the repository, or use the in-browser editor to make your + changes. + +1. [Open a Pull Request][pr] to propose your changes. + +1. Review an test output and linters, and address the issues. Because of how + GitHub injects secrets into CI/CD, your _integration_ tests may fail. This + is expected and our team will invoke the integration tests with our + credentials. Other test types must pass. + +1. Our team will review the contribution. If it meets the project's goals and + standards, we will likely accept the contribution. + + **For significant contributions or expanding scope, please open an issue + first to ensure your contribution is in line with the project's goals.** + + +[org]: https://github.com/google-github-actions +[coc]: https://github.com/google-github-actions/.github/blob/main/CODE_OF_CONDUCT.md +[clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository +[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo +[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request