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

Add ASOv1 to ASOv2 migration guide #3898

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

matthchr
Copy link
Member

@matthchr matthchr commented Mar 29, 2024

Fixes #3006
Fixes #3342

If applicable:

  • this PR contains documentation
  • this PR contains tests
  • this PR contains YAML Samples

Once you've applied the above, make sure to update your applications to depend on the new secret
written by ASOv2.

TODO: How to work around connection string issues?
Copy link
Member Author

Choose a reason for hiding this comment

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

Clear up this TODO

@matthchr matthchr changed the title Add ASOv1 to ASOv2 migration Add ASOv1 to ASOv2 migration guide Mar 29, 2024
@matthchr matthchr force-pushed the feature/asov1-asov2-migration branch 2 times, most recently from b21326a to 1db5383 Compare March 29, 2024 23:09
Copy link
Member

@theunrepentantgeek theunrepentantgeek left a comment

Choose a reason for hiding this comment

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

Looks extremely good! I've commented on some nitpicks but overall this is solid.

docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
Comment on lines +40 to +41
> You can run `helm upgrade` and pass `--set certManagerResourcesAPIVersion=cert-manager.io/v1` to ensure ASOv1 is using
> the v1 versions of the cert-manager resources.
Copy link
Member

Choose a reason for hiding this comment

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

Does this do an upgrade, or just return an error if non v1 versions are in use?

Copy link
Member Author

Choose a reason for hiding this comment

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

It depends a bit on what you mean by "upgrade". It doesn't change the versions of any resources in the cluster (container images, helm charts, etc), at least assuming you use the same version of the ASOv1 chart as you already have installed. What it does is delete the ASOv1 v1alpha2 cert-manager CRs and replace them with v1 cert-manager CRs.

So the net effect of this is:

  • Delete v1alpha2 cert manager custom resources (not the CRDs, the CRs)
  • Create v1 cert manager custom resources w/ same configuration as above.

docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved

### Stop ASOv1 reconciliation

Mark each ASOv1 resource with the `skipreconcile=true` annotation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This must be hard to add and remove annotation on each resource.
Should have a way in ASOv2 to pause reconciliation at the controller level for all resources, if not already there?

Copy link
Member Author

Choose a reason for hiding this comment

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

I give commands just below of how to do it for a whole namespace at once. It's a one-liner so I don't think we need any other features. At most, we could make an asoctl feature to do the one-line like asoctl annotate all or something, but I don't think it's needed atm really.

@matthchr matthchr force-pushed the feature/asov1-asov2-migration branch from 1db5383 to 6e384fe Compare April 3, 2024 20:18
@matthchr matthchr added the documentation Improvements or additions to documentation label Apr 3, 2024
@matthchr
Copy link
Member Author

matthchr commented Apr 3, 2024

/ok-to-test sha=6e384fe

@matthchr
Copy link
Member Author

matthchr commented Apr 3, 2024

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@matthchr
Copy link
Member Author

matthchr commented Apr 4, 2024

/ok-to-test sha=6e384fe

@matthchr matthchr added this pull request to the merge queue Apr 4, 2024
Merged via the queue into Azure:main with commit 8e03d50 Apr 4, 2024
9 checks passed
@matthchr matthchr deleted the feature/asov1-asov2-migration branch April 4, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
3 participants