docs(gke): detail how to configure workload identity #4373
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tatic credentials or the node service accounts as per googles best practices [noted here](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys#alternatives) and their [flow diagram](https://cloud.google.com/docs/authentication#auth-decision-tree) where it noted GKE users should use workload identity
k8s-ci-robot
added
the
cncf-cla: yes
|
Welcome @userbradley! |
|
Hi @userbradley. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
needs-ok-to-test
userbradley
commented
Apr 9, 2024
| @@ -14,7 +14,7 @@ This solution will only work when both CloudDNS and GKE are provisioned in the s | |||
|
|
|||
| ### Configure Project Environment | |||
|
|
|||
| Setup your environment to work with Google Cloud Platform. Fill in your variables as needed, e.g. target project. | |||
| Set up your environment to work with Google Cloud Platform. Fill in your variables as needed, e.g. target project. | |||
There was a problem hiding this comment.
the word set up is used to make arrangements
userbradley
commented
Apr 9, 2024
|
|
||
| You have an option to chose from using the gcloud CLI or using Terraform. | ||
|
|
||
| === "gcloud CLI" |
There was a problem hiding this comment.
Allows for a tabbed view, users can click gcloud CLI or terraform opposed to a new ### section that could confuse users
There was a problem hiding this comment.
I tested it locally. It looks good. Thanks 👍
userbradley
commented
Apr 9, 2024
Comment on lines
+302
to
+304
| !!! note "Only required if not enabled on all nodes" | ||
| If you have GKE Workload Identity enabled on all nodes in your cluster, the below step is not necessary | ||
|
|
There was a problem hiding this comment.
If users have enabled workload identity on the cluster, all nodes should have the metadata API daemon set on them, so I've added this in in case users think they need to do this
|
@mloiseleur PR is ready for your review please |
|
Thanks for providing also Terraform code example. |
k8s-ci-robot
added
the
lgtm
|
/retitle docs(gke): detail how to configure workload identity |
k8s-ci-robot
changed the title
|
Hey @mloiseleur this is my first time contributing to k8's and I'm a little confused on what's the next steps for my PR? I'd like to be put down as the SME for the Google GKE docs, but I've got 0 clue what to do next haha. Appreciate your guidance here |
|
@userbradley Don't worry. It will be reviewed by an other maintainer and then, merged. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Raffo The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
truecharts-admin
added a commit
to truecharts/charts
that referenced
this pull request
May 17, 2024
…rnal-dns to v0.14.2@3fcad62 by renovate (#22163) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [registry.k8s.io/external-dns/external-dns](https://github.com/kubernetes-sigs/external-dns) | patch | `v0.14.1` -> `v0.14.2` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>kubernetes-sigs/external-dns (registry.k8s.io/external-dns/external-dns)</summary> ### [`v0.14.2`](https://github.com/kubernetes-sigs/external-dns/releases/tag/v0.14.2) [Compare Source](https://github.com/kubernetes-sigs/external-dns/compare/v0.14.1...v0.14.2) #### What's Changed - kustomize-v0.14.1 by [@​Raffo](https://github.com/Raffo) in [kubernetes-sigs/external-dns#4331 - replace all links in tutorials for v0.14.1 by [@​Raffo](https://github.com/Raffo) in [kubernetes-sigs/external-dns#4332 - chore: upgrade ExternalDNS to go 1.22 by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4318 - build(deps): bump the dev-dependencies group with 13 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4329 - build(deps): bump the dev-dependencies group with 5 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4334 - build(deps): bump the dev-dependencies group with 9 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4349 - build(deps): bump the dev-dependencies group with 1 update by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4341 - Add `dnsendpoint` CRD to Helm chart by [@​onedr0p](https://github.com/onedr0p) in [kubernetes-sigs/external-dns#4322 - build(deps): bump the dev-dependencies group with 13 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4361 - build(deps): bump GrantBirki/json-yaml-validate from 2.6.1 to 2.6.2 in the dev-dependencies group by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4364 - chore(chart): Released chart for v0.14.1 by [@​stevehipwell](https://github.com/stevehipwell) in [kubernetes-sigs/external-dns#4357 - chore: alphabetical order on providers by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4350 - doc: advertise current plan on providers by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4365 - Fix(ipv6): support ipv6 shortener and expander equal by [@​dongjiang1989](https://github.com/dongjiang1989) in [kubernetes-sigs/external-dns#4351 - feat(WebhookProvider): Let WebhookProvider return `SoftError` on response status codes >= 500 by [@​SimonKienzler](https://github.com/SimonKienzler) in [kubernetes-sigs/external-dns#4319 - Webhook provider: Use correct error gauge in `AdjustEndpoints()` func by [@​SimonKienzler](https://github.com/SimonKienzler) in [kubernetes-sigs/external-dns#4374 - build(deps): bump the dev-dependencies group with 18 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4381 - Add exclude domains value in Chart by [@​bford-evs](https://github.com/bford-evs) in [kubernetes-sigs/external-dns#4380 - docs(aws): fix typo and upgrade cleanup flow by [@​franzudev](https://github.com/franzudev) in [kubernetes-sigs/external-dns#4389 - docs(gke): detail how to configure workload identity by [@​userbradley](https://github.com/userbradley) in [kubernetes-sigs/external-dns#4373 - chore(ci): fix failing test by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4397 - chore: Update controller-tools version to v0.14.0 by [@​dongjiang1989](https://github.com/dongjiang1989) in [kubernetes-sigs/external-dns#4400 - chore(ci): update golangci-lint to v1.57.2 by [@​dongjiang1989](https://github.com/dongjiang1989) in [kubernetes-sigs/external-dns#4406 - chore: upgrade ExternalDNS to go 1.22.2 by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4414 - build(deps): bump the dev-dependencies group across 1 directory with 4 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4412 - build(deps): bump the dev-dependencies group across 1 directory with 24 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4416 - custom Azure Active Directory Authority Host by [@​Jeremy-Boyle](https://github.com/Jeremy-Boyle) in [kubernetes-sigs/external-dns#4210 - feat(DNSimple): User API tokens by [@​IntegralProgrammer](https://github.com/IntegralProgrammer) in [kubernetes-sigs/external-dns#4274 - docs: annotation placement for azuredns tutorial by [@​jonas-budde](https://github.com/jonas-budde) in [kubernetes-sigs/external-dns#4415 - feat(azure): add zone name filter for Azure Private DNS by [@​khuedoan](https://github.com/khuedoan) in [kubernetes-sigs/external-dns#4346 - test: detect no change necessary with provider specific config by [@​szuecs](https://github.com/szuecs) in [kubernetes-sigs/external-dns#4189 - docs: add setup example with helm chart on some providers by [@​omerap12](https://github.com/omerap12) in [kubernetes-sigs/external-dns#4405 - test: controller run() and successfully shutdown by [@​szuecs](https://github.com/szuecs) in [kubernetes-sigs/external-dns#3639 - fix syntax on cloudflare externalDNS by [@​ilyesAj](https://github.com/ilyesAj) in [kubernetes-sigs/external-dns#4436 - build(deps): bump the dev-dependencies group across 1 directory with 11 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4440 - chore(chart): Adding extra containers by [@​omerap12](https://github.com/omerap12) in [kubernetes-sigs/external-dns#4432 - aws: add ca-west-1 region by [@​jeremy-albuixech](https://github.com/jeremy-albuixech) in [kubernetes-sigs/external-dns#4444 - fix: duplicated endpoint per hosted zone by [@​leonardocaylent](https://github.com/leonardocaylent) in [kubernetes-sigs/external-dns#4296 - build(deps): bump actions/checkout from 4.1.4 to 4.1.5 in the dev-dependencies group by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4438 - Add IPv6 AAAA record support to PiHole provider by [@​PseudoResonance](https://github.com/PseudoResonance) in [kubernetes-sigs/external-dns#4324 - fix: soft error on cloudflare rate limits by [@​ebachle](https://github.com/ebachle) in [kubernetes-sigs/external-dns#4437 - Update cloudflare.md by [@​mfreeman451](https://github.com/mfreeman451) in [kubernetes-sigs/external-dns#4449 - Fix headings, whitespace by [@​stefanlasiewski](https://github.com/stefanlasiewski) in [kubernetes-sigs/external-dns#4457 - docs: add reference to anexia webhook provider by [@​ProbstenHias](https://github.com/ProbstenHias) in [kubernetes-sigs/external-dns#4441 - fix logline mentioning plugin api by [@​Raffo](https://github.com/Raffo) in [kubernetes-sigs/external-dns#4459 - docs: lint gke docs + make terraform config more secure by [@​DrFaust92](https://github.com/DrFaust92) in [kubernetes-sigs/external-dns#4456 - build(deps): bump action-stars/install-tool-from-github-release from 0.2.2 to 0.2.3 in the dev-dependencies group by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4464 - changed documentation to include more details description when using API Tokens by [@​rhjensen79](https://github.com/rhjensen79) in [kubernetes-sigs/external-dns#4474 - fix: add clarification to endpoint unit tests by [@​leonardocaylent](https://github.com/leonardocaylent) in [kubernetes-sigs/external-dns#4462 - build(deps): bump the dev-dependencies group across 1 directory with 19 updates by [@​mloiseleur](https://github.com/mloiseleur) in [kubernetes-sigs/external-dns#4476 - build(deps): bump the dev-dependencies group across 1 directory with 19 updates by [@​dependabot](https://github.com/dependabot) in [kubernetes-sigs/external-dns#4475 #### New Contributors - [@​onedr0p](https://github.com/onedr0p) made their first contribution in [kubernetes-sigs/external-dns#4322 - [@​SimonKienzler](https://github.com/SimonKienzler) made their first contribution in [kubernetes-sigs/external-dns#4319 - [@​bford-evs](https://github.com/bford-evs) made their first contribution in [kubernetes-sigs/external-dns#4380 - [@​franzudev](https://github.com/franzudev) made their first contribution in [kubernetes-sigs/external-dns#4389 - [@​userbradley](https://github.com/userbradley) made their first contribution in [kubernetes-sigs/external-dns#4373 - [@​Jeremy-Boyle](https://github.com/Jeremy-Boyle) made their first contribution in [kubernetes-sigs/external-dns#4210 - [@​IntegralProgrammer](https://github.com/IntegralProgrammer) made their first contribution in [kubernetes-sigs/external-dns#4274 - [@​jonas-budde](https://github.com/jonas-budde) made their first contribution in [kubernetes-sigs/external-dns#4415 - [@​khuedoan](https://github.com/khuedoan) made their first contribution in [kubernetes-sigs/external-dns#4346 - [@​omerap12](https://github.com/omerap12) made their first contribution in [kubernetes-sigs/external-dns#4405 - [@​ilyesAj](https://github.com/ilyesAj) made their first contribution in [kubernetes-sigs/external-dns#4436 - [@​jeremy-albuixech](https://github.com/jeremy-albuixech) made their first contribution in [kubernetes-sigs/external-dns#4444 - [@​leonardocaylent](https://github.com/leonardocaylent) made their first contribution in [kubernetes-sigs/external-dns#4296 - [@​PseudoResonance](https://github.com/PseudoResonance) made their first contribution in [kubernetes-sigs/external-dns#4324 - [@​ebachle](https://github.com/ebachle) made their first contribution in [kubernetes-sigs/external-dns#4437 - [@​mfreeman451](https://github.com/mfreeman451) made their first contribution in [kubernetes-sigs/external-dns#4449 - [@​ProbstenHias](https://github.com/ProbstenHias) made their first contribution in [kubernetes-sigs/external-dns#4441 - [@​DrFaust92](https://github.com/DrFaust92) made their first contribution in [kubernetes-sigs/external-dns#4456 - [@​rhjensen79](https://github.com/rhjensen79) made their first contribution in [kubernetes-sigs/external-dns#4474 **Full Changelog**: kubernetes-sigs/external-dns@v0.14.1...v0.14.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM2OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbImF1dG9tZXJnZSIsInVwZGF0ZS9kb2NrZXIvZ2VuZXJhbC9ub24tbWFqb3IiXX0=-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updating the GKE workload identity page as per #4362, as the way it works has changed in the past 2 weeks
I have also made the decision to move the workload identity section higher up in the documentation and below is my logic
Fixes #4362
Checklist
Commits signed, and I should have an existing CLA with the CNCF