Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

helm-docs: add migration guides around PodSecurityPolicy and chart 5.0 #5457

Merged
merged 6 commits into from
Jul 10, 2023

Conversation

krajorama
Copy link
Contributor

What this PR does

Describe how to migrate to Kubernetes 1.25 with the helm chart.
Describe how to migrate from helm chart 4.x to 5.0.

Which issue(s) this PR fixes or relates to

Related to: #5357

Checklist

  • N/A Tests updated
  • Documentation added
  • N/A CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Describe how to migrate to Kubernetes 1.25 with the helm chart.
Describe how to migrate from helm chart 4.x to 5.0.

Related to: #5357

Signed-off-by: György Krajcsovits <[email protected]>
@krajorama krajorama requested review from a team as code owners July 10, 2023 08:17
@krajorama krajorama added type/docs Improvements or additions to documentation helm labels Jul 10, 2023
@krajorama krajorama requested a review from osg-grafana July 10, 2023 08:17
Signed-off-by: György Krajcsovits <[email protected]>
forcePSPOnKubernetes124: true
```

> **Note**: Warning: this value prevents you from upgrading to Kubernetes version 1.25! Follow the other option before upgrading to Kubernetes 1.25.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

forcePSPOnKubernetes124: true
```

> **Note**: Warning: this value prevents you from upgrading to Kubernetes version 1.25! Follow the other option before upgrading to Kubernetes 1.25.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Note**: Warning: this value prevents you from upgrading to Kubernetes version 1.25! Follow the other option before upgrading to Kubernetes 1.25.
> **Note**: Warning: this value prevents you from upgrading to Kubernetes version 1.25. Follow the other option before upgrading to Kubernetes 1.25.

Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment about note and warning admonitions.

Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing. Only a few minor suggestions, but otherwise LGTM

krajorama and others added 4 commits July 10, 2023 16:37
Currently admonition cannot be part of a list, working around that.

Signed-off-by: György Krajcsovits <[email protected]>
Co-authored-by: Dimitar Dimitrov <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
Signed-off-by: György Krajcsovits <[email protected]>
@krajorama krajorama enabled auto-merge (squash) July 10, 2023 14:52
@krajorama krajorama merged commit cca9399 into main Jul 10, 2023
@krajorama krajorama deleted the krajo/helm-k8s-1-24-migration branch July 10, 2023 15:02
Comment on lines +20 to +25
1. If you are on Kubernetes version 1.24 and want to keep using PodSecurityPolicy, then merge the following setting into your custom values file:
```yaml
rbac:
forcePSPOnKubernetes124: true
```
1. If you have Kubernetes version 1.22 or later and want to upgrade to Kubernetes version 1.25 after this procedure then follow the [Migrate to Kubernetes version 1.25]({{< relref "./migrate-to-kubernetes-version-1.25.md" >}}) guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we give one more option? "Don't do anything", since this is what I expect most users will need.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't see this due to auto merge. Yes, I suppose that's valid, just have to formulate carefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
helm type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants