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

doc: Update Harvester Addon Configuration Examples #368

Closed

Conversation

irishgordo
Copy link
Contributor

Super willing to iterate and update this as needed but wanted to push up a slight change 😄

Given that there is a distinction between UI "naming" and Helm Chart naming:
Screenshot from 2023-07-26 11-36-32
Screenshot from 2023-07-26 11-32-52

And that in order for the configuration to work, if serving remotely as a configuration, the syntax in the YAML will need to change shifting from - (hypens) to _ (underscores).

Additionally, sharing out to docs about valuescontent as a property on the addon.

This PR updates the way the user is informed of:

  • proper YAML configuration for enablement
  • the distinction between "chart name"/"chartname" (helm chart name) and what the user would see through the Web UI (if enabling through WebUI/harvester-dashboard, instead of kubectl edits)
  • additionally providing the valuescontent property as a configuration element

@netlify
Copy link

netlify bot commented Jul 26, 2023

Deploy Preview for harvester-preview ready!

Name Link
🔨 Latest commit 8f49f2f
🔍 Latest deploy log https://app.netlify.com/sites/harvester-preview/deploys/64d4235cd26cf200088a42c5
😎 Deploy Preview https://deploy-preview-368--harvester-preview.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.

docs/install/harvester-configuration.md Outdated Show resolved Hide resolved
docs/install/harvester-configuration.md Outdated Show resolved Hide resolved
@irishgordo irishgordo force-pushed the fix/update-addon-config-examples branch from 1f92c03 to 7fbe1d6 Compare August 9, 2023 23:30
* updating Harvester addon configuration docs to represent the yaml more accurately
* updating the Harvester addon docs to display information surrounding
  the naming that is displayed in the UI to the end user in contrast to
  the naming that is displayed via kubectl commands to the cluster that
  demonstrate the "chartName"

Resolves: fix/update-addon-config-examples
@irishgordo irishgordo force-pushed the fix/update-addon-config-examples branch from 7fbe1d6 to 8f49f2f Compare August 9, 2023 23:38
@irishgordo
Copy link
Contributor Author

irishgordo commented Aug 9, 2023

Deprecating this PR - will open another - rebased but amended commit, causing overwriting of git history.
Newer: #383

@LucasSaintarbor
Copy link
Contributor

Deprecating this PR - will open another - rebased but amended commit, causing overwriting of git history. Newer: #383

Thanks @irishgordo!

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.

3 participants