Update broken and outdated links in Helm chart values.yaml
What does this MR do?
While working with the gitlab-runner Helm chart recently I noticed a few urls that didn’t lead to the expected documentation. This MR therefore fixes broken or outdated links in the values.yaml
of the gitlab-runner Helm chart.
Here’s a list of the old links, their updates and the reason for the updates:
rbac.rules
- old: https://docs.gitlab.com/runner/executors/kubernetes.html#configuring-executor-service-account
- new: https://docs.gitlab.com/runner/executors/kubernetes.html#configure-runner-api-permissions
- reason: the current link leads to a part of the documentation that doesn’t mention the rbac permissions. The updated link seems to be more fitting
serviceAccountAnnotations
- old: https://docs.aws.amazon.com/eks/latest/userguide/specify-service-account-role.html
- new: https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html
- reason: the old link leads to a general documentation of EKS, but not how to specify a role for a service account
serviceMonitor.tlsConfig
- old: https://github.com/helm/charts/blob/master/stable/prometheus-operator/crds/crd-servicemonitor.yaml
- new: https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/charts/crds/crds/crd-servicemonitors.yaml
- reason: The Helm chart of the prometheus-operator was combined with the Helm chart of kube-prometheus-stack as mentioned in this Readme: https://github.com/prometheus-operator/prometheus-operator/tree/main/helm
securityContext
- old: http://kubernetes.io/docs/user-guide/security-context/
- new: https://kubernetes.io/docs/concepts/security/pod-security-standards/
- reason: The old url leads to a 404 page.
podSecurityContext
- old: http://kubernetes.io/docs/user-guide/security-context/
- new: https://kubernetes.io/docs/concepts/security/pod-security-standards/
- reason: The old url leads to a 404 page.
resources
- old: http://kubernetes.io/docs/user-guide/compute-resources/
- new: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- reason: The old url leads to a 404 page.
nodeSelector
- old: https://kubernetes.io/docs/user-guide/node-selection/
- new: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
- reason: The old url leads to a 404 page.
Why was this MR needed?
The links to the documentation should be up-to-date so that people, who use this Helm chart know where to find further information for specific topics.
What's the best way to test this MR?
Check whether the updated urls link to the correct documentation now.