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.

Sign up for GitHub

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

Jump to bottom

Update install instructions, making them consistent for all sub-projects #1449

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update install instructions, making them consistent for all sub-projects #1449

wants to merge 1 commit into from
+52 −61

Conversation

inteon
Copy link
Member

@inteon inteon commented Mar 15, 2024 •
edited

Goal:
Reach base level of consistency for installation commands across all installation pages.
Once we reach consistency, we can think about improving these instructions (keeping in mind the CRD changes coming in 1.15).

Next steps:

  1. Prepare 1.15 release (drastically simplify the CRD install section & use the single fool-proof install command everywhere)

@jetstack-bot jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 15, 2024
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from inteon. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify Netlify
Copy link

netlify bot commented Mar 15, 2024 •
edited

✅ Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 85d00a6
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/665d833ed312050008b47890
😎 Deploy Preview https://deploy-preview-1449--cert-manager-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@inteon inteon requested a review from wallrj March 15, 2024 08:17
wallrj
wallrj requested changes Mar 15, 2024
View reviewed changes
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

  1. Seems like unnecessary churn to me.
  2. It introduces the cert-manager version everywhere, giving the false impression (I think) that istio-csr, csi-driver, etc depend on that particular version. As I already said in another review.
  3. I think the goal should be to remove the helm **upgrade** instruction from each of the component install pages, because it risks users accidentally upgrading an important existing cert-manager installation and this change does not advance that goal.
  4. I don't have time to test all the changes.

Have you tested everything?

@inteon
Copy link
Member Author

inteon commented Mar 15, 2024

Have you tested everything?
No, the commands have not changed, I only expanded the flags.
The only command that changed is the command that disables the approval-controller, and I copied that command from the approver-policy install page.

@cert-manager-prow cert-manager-prow bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 17, 2024
@inteon inteon force-pushed the consistent_install_instructions branch from f737f89 to 8419e69 Compare June 3, 2024 07:49
@cert-manager-prow cert-manager-prow bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 3, 2024
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from inteon. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@inteon
Copy link
Member Author

inteon commented Jun 3, 2024

@wallrj

I updated the cert-manager instructions for approver-policy and csi-driver-spiffe (replaced helm install/ helm upgrade --install with helm upgrade --reuse-values. I also tested that this works as expected for the approver-policy installation.

@inteon inteon requested a review from wallrj June 3, 2024 08:08
@inteon inteon force-pushed the consistent_install_instructions branch from 8419e69 to af5626d Compare June 3, 2024 08:09
@inteon
update install instructions, making them consistent for all sub-projects
85d00a6 
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
@inteon inteon force-pushed the consistent_install_instructions branch from af5626d to 85d00a6 Compare June 3, 2024 08:47
@cert-manager-prow cert-manager-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 3, 2024
inteon
inteon commented Jun 3, 2024
View reviewed changes
content/docs/installation/helm.md
@@ -28,13 +28,7 @@ Notably, the "Helm stable repository" version of cert-manager is deprecated and
helm repo add jetstack https://charts.jetstack.io --force-update
```

#### 2. Update your local Helm chart repository cache:
Copy link
Member Author

@inteon inteon Jun 3, 2024 •
edited

Choose a reason for hiding this comment

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

This section has become redundant: --force-update is used above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wallrj wallrj Awaiting requested review from wallrj

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@inteon @jetstack-bot @wallrj