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

Install and upgrade csi-powemax with reverse proxy secret #1423

Merged
merged 11 commits into from
Jan 23, 2025

Conversation

lukeatdell
Copy link
Contributor

Description

Updating install and upgrade documentation to guide users through the process of installing and upgrading csi-powermax using the reverse proxy secret.

GitHub Issues

GitHub Issue #
dell/csm#1614

Checklist:

  • Have you run a grammar and spell checks against your submission?
  • Have you tested the changes locally?
  • Have you tested whether the hyperlinks are working properly?
  • Did you add the examples wherever applicable?
  • Have you added high-resolution images? Not applicable

Copy link

github-actions bot commented Jan 17, 2025

Test Results

77 tests  ±0   77 ✅ ±0   3s ⏱️ ±0s
 3 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit a3929e6. ± Comparison against base commit 34cc99a.

♻️ This comment has been updated with latest results.

lukeatdell and others added 2 commits January 17, 2025 10:07
- csireverseproxy.secretName is changed in favor of csireverseproxy.useSecret and global.defaultCredentialsSecret to match operator install implementation.
- default value for global.defaultCredentialsSecret changed to "powermax-config" to match operator implementation
@lukeatdell lukeatdell changed the base branch from main to usr/spark/powermax-secret January 21, 2025 20:37
@lukeatdell lukeatdell marked this pull request as ready for review January 21, 2025 20:45
Copy link

@rsedlock1958 rsedlock1958 left a comment

Choose a reason for hiding this comment

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

I have reviewed this. No edits are needed.

- Changing wording in upgrade instructions.
- Rearranging examples and details for the secret creation.
- Fixed installation step numbering.
Copy link

@rsedlock1958 rsedlock1958 left a comment

Choose a reason for hiding this comment

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

I have reviewed this. No edits required.

```bash
cd ../dell-csi-helm-installer && ./csi-install.sh --namespace powermax --values ./my-powermax-settings.yaml --upgrade --helm-charts-version <version>
kubectl create secret generic powermax-config --namespace powermax --from-file=config=samples/secret/secret.yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

I would think the user knows that the directory to be in is the csi-powermax directory but in other places we indicate to work in the repo directory.

Copy link
Contributor Author

@lukeatdell lukeatdell Jan 23, 2025

Choose a reason for hiding this comment

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

The reason I added it is because we offer the 'copy' option for these bash examples. I'm of the opinion, as the user follows along, they should be able to copy and paste the commands into their terminal and it should work, nearly all the time, with as little editing as possible.
I agree, most users will know where they are in the directory tree, so it is a bit redundant, but this removes any ambiguity and simplifies the install process.

But thanks for mentioning this. I was able to improve the flow of the upgrade instructions with this feedback!

- add a few bash examples to allow easier copy-pasting of commands during upgrade
Copy link

@rsedlock1958 rsedlock1958 left a comment

Choose a reason for hiding this comment

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

I have reviewed this. No grammatical edits are needed.

@lukeatdell lukeatdell merged commit f257315 into usr/spark/powermax-secret Jan 23, 2025
@lukeatdell lukeatdell deleted the usr/lukeatdell/powermax-secret branch January 23, 2025 18:01
@anandrajak1 anandrajak1 restored the usr/lukeatdell/powermax-secret branch January 23, 2025 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants