Skip to content

docs: upgrade guide for certificates #355

New issue

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

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

Already on GitHub? # to your account

Closed
wants to merge 3 commits into from
Closed

docs: upgrade guide for certificates #355

wants to merge 3 commits into from

Conversation

itzsaga
Copy link
Member

@itzsaga itzsaga commented May 5, 2025

How to upgrade after the merging and removal of kube_cert_manager and kube_cert_issuers.


Important

Adds upgrade guide for merging kube_cert_manager and kube_cert_issuers into kube_certificates in edge.mdx.

  • Breaking Changes:
    • Consolidates kube_cert_manager and kube_cert_issuers into kube_certificates.
    • Provides upgrade steps in edge.mdx:
      • Pull state files from kube_cert_issuers and kube_cert_manager.
      • Create kube_certificates directory and terragrunt.hcl file.
      • Update Panfactum framework version.
      • Initialize terragrunt in kube_certificates.
      • Merge state files and remove duplicate resources.
      • Apply changes and remove old directories.

This description was created by Ellipsis for c6f3aad. You can customize this summary. It will automatically update as commits are pushed.

@itzsaga itzsaga requested a review from uptownhr May 5, 2025 21:39
@itzsaga itzsaga self-assigned this May 5, 2025
@itzsaga itzsaga requested a review from fullykubed as a code owner May 5, 2025 21:39
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Caution

Changes requested ❌

Reviewed everything up to c6f3aad in 3 minutes and 0 seconds. Click for details.
  • Reviewed 62 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. packages/website/src/content/docs/changelog/edge.mdx:26
  • Draft comment:
    Grammar issue: Change "We have consolidates" to "We have consolidated".
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative and focuses on a grammar correction. It does not provide any code suggestions or improvements related to the functionality or logic of the code. Therefore, it should be removed according to the rules.
2. packages/website/src/content/docs/changelog/edge.mdx:29
  • Draft comment:
    Clarify text: Instead of "from the kube_cert_manager directly", consider using "from the kube_cert_manager directory".
  • Reason this comment was not posted:
    Marked as duplicate.
3. packages/website/src/content/docs/changelog/edge.mdx:26
  • Draft comment:
    Typo: Change 'consolidates' to 'consolidated'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 30% vs. threshold = 50% The comment is about a clear grammatical error in the changelog. While it's a minor issue, changelogs are important documentation that should be professionally written. The fix is clear and actionable. However, the rules say not to make comments that are obvious or unimportant. A simple grammar fix in documentation (not code) could be considered unimportant. The comment is technically correct but may be too minor to warrant a formal PR comment. Documentation grammar fixes could be handled more efficiently through direct edits. While minor, clear and professional documentation helps establish credibility and reduces confusion. The fix is very straightforward. Given that this is a simple grammar fix in documentation rather than code, and the rules specifically say not to make obvious/unimportant comments, this comment should be removed despite being technically correct.
4. packages/website/src/content/docs/changelog/edge.mdx:29
  • Draft comment:
    Use 'directory' instead of 'directly' for consistency.
  • Reason this comment was not posted:
    Marked as duplicate.
5. packages/website/src/content/docs/changelog/edge.mdx:43
  • Draft comment:
    Typo: Change 'replaces' to 'replaced'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% This is a simple grammar correction - "replaces" should indeed be "replaced" since it's referring to resources that will be replaced (past participle). The change would improve readability. However, per the rules, we should not make purely informative comments or comments about obvious issues. The grammar error is minor and does not significantly impact understanding. The rules state we should not make purely informative comments. While the grammar correction is valid, it falls into the category of comments that are not actionable enough to warrant inclusion. The comment should be deleted as it is a minor grammar correction that does not materially impact understanding of the documentation.
6. packages/website/src/content/docs/changelog/edge.mdx:26
  • Draft comment:
    Typo: Consider changing 'We have consolidates the kube_cert_manager and kube_cert_issuers modules' to 'We have consolidated the kube_cert_manager and kube_cert_issuers modules'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% This is a simple typo fix in a changelog file. The typo is clear and the fix is straightforward. The comment is about a changed line in the diff. However, the rules state not to make comments that are obvious or unimportant. A simple typo in a changelog is not critical to functionality and would be considered unimportant. The typo does affect readability slightly and makes the text less professional. Perhaps fixing it would improve documentation quality. While documentation quality is important, this is a very minor typo that doesn't significantly impact understanding. The rules clearly state to avoid obvious/unimportant comments. The comment should be removed as it points out an unimportant typo that doesn't materially affect functionality or understanding.

Workflow ID: wflow_DZORocsUIcMQzx5R

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@@ -21,6 +21,57 @@ import MarkdownAlert from "@/components/markdown/MarkdownAlert.astro";

### Breaking Changes

### Breaking Changes
Copy link
Contributor

Choose a reason for hiding this comment

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

Duplicate heading detected. Remove or consolidate the repeated 'Breaking Changes' heading.

Suggested change
### Breaking Changes

1. Before updating your version:
a. Run `terragrunt state pull > kube_cert_issuers.json` from the `kube_cert_issuers` directory.
b. Run `terragrunt state pull > kube_cert_manager.json` from the `kube_cert_manager` directly.
2. Create a `kube_certificates` directly as a sibling to the `kube_cert_manager` and `kube_cert_issuers` directories.
Copy link
Contributor

Choose a reason for hiding this comment

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

Replace 'directly' with 'directory' in step 2.

Suggested change
2. Create a `kube_certificates` directly as a sibling to the `kube_cert_manager` and `kube_cert_issuers` directories.
2. Create a `kube_certificates` directory as a sibling to the `kube_cert_manager` and `kube_cert_issuers` directories.

a. Run `terragrunt state pull > kube_cert_issuers.json` from the `kube_cert_issuers` directory.
b. Run `terragrunt state pull > kube_cert_manager.json` from the `kube_cert_manager` directly.
2. Create a `kube_certificates` directly as a sibling to the `kube_cert_manager` and `kube_cert_issuers` directories.
3. Create a `terragrunt.hcl` file in the `kube_certificates` directly with the following contents:
Copy link
Contributor

Choose a reason for hiding this comment

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

Replace 'directly' with 'directory' in step 3.

Suggested change
3. Create a `terragrunt.hcl` file in the `kube_certificates` directly with the following contents:
3. Create a `terragrunt.hcl` file in the `kube_certificates` directory with the following contents:

* We have consolidates the `kube_cert_manager` and `kube_cert_issuers` modules into a singular `kube_certificates` module. Follow these steps to upgrade:
1. Before updating your version:
a. Run `terragrunt state pull > kube_cert_issuers.json` from the `kube_cert_issuers` directory.
b. Run `terragrunt state pull > kube_cert_manager.json` from the `kube_cert_manager` directly.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: 'from the kube_cert_manager directly' likely should be 'from the kube_cert_manager directory' to match the context of the instructions.

Suggested change
b. Run `terragrunt state pull > kube_cert_manager.json` from the `kube_cert_manager` directly.
b. Run `terragrunt state pull > kube_cert_manager.json` from the `kube_cert_manager` directory.

7. Merge the contents from the `./kube_cert_manager/kube_cert_manager.json` outputs key into the `./kube_certificates/kube_certificates_state.json` outputs key.
8. Merge the contents from the `./kube_cert_manager/kube_cert_manager.json` resources array into the `./kube_certificates/kube_certificates_state.json` resources array.
9. Find the resource object with a type key of `"pf_kube_labels"` and delete it from the resources array. It is a duplicate and will cause an error.
10. Run `terragrunt plan` and review the changes. There should be only a few resources that will be replaces as we fixed a typo in the name.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: The phrase 'there should be only a few resources that will be replaces' should be corrected to 'there should be only a few resources that will be replaced'.

Suggested change
10. Run `terragrunt plan` and review the changes. There should be only a few resources that will be replaces as we fixed a typo in the name.
10. Run `terragrunt plan` and review the changes. There should be only a few resources that will be replaced as we fixed a typo in the name.

@itzsaga itzsaga marked this pull request as draft May 5, 2025 22:34
@itzsaga
Copy link
Member Author

itzsaga commented May 5, 2025

Need to add replacing dependency paths with new folder path.

@itzsaga
Copy link
Member Author

itzsaga commented May 9, 2025

Moving into other PR.

@itzsaga itzsaga closed this May 9, 2025
@itzsaga itzsaga deleted the upgrade-guide branch May 9, 2025 22:15
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant