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 EC --config-values flag and update automated install docs #2830

Merged
merged 14 commits into from
Nov 19, 2024
Merged

Conversation

paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented Nov 18, 2024

EC install command reference doc: https://deploy-preview-2830--replicated-docs-upgrade.netlify.app/reference/embedded-cluster-install#flags

Added online and air gap EC install steps to the Installing with the CLI topic: https://deploy-preview-2830--replicated-docs-upgrade.netlify.app/enterprise/installing-existing-cluster-automation

Update the steps on how to get the ConfigValues file to account for EC users (previously it just included the kots get config command for kots existing cluster): https://deploy-preview-2830--replicated-docs-upgrade.netlify.app/vendor/releases-configvalues

@paigecalvert paigecalvert requested a review from a team as a code owner November 18, 2024 18:32
@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Nov 18, 2024
Copy link

netlify bot commented Nov 18, 2024

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 1a14a45
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/673cbbfe9862d7000725d189
😎 Deploy Preview https://deploy-preview-2830--replicated-docs-upgrade.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.

Copy link

netlify bot commented Nov 18, 2024

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 1a14a45
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/673cbbfe0f10be000829650f
😎 Deploy Preview https://deploy-preview-2830--replicated-docs.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.

@paigecalvert paigecalvert changed the title Add --config-values flag Add EC --config-values flag and update automated install docs Nov 18, 2024
sidebars.js Outdated Show resolved Hide resolved
docs/reference/embedded-cluster-install.mdx Show resolved Hide resolved
docs/vendor/releases-configvalues.md Outdated Show resolved Hide resolved
docs/vendor/releases-configvalues.md Show resolved Hide resolved

After you get the ConfigValues file for your application using the `kots get config` command, Replicated recommends that you do the following to edit the contents of the ConfigValues file before sharing it with users:
Before sharing a sample ConfigValues with users, Replicated recommends that you edit the sample file in the following ways:

* Remove any configuration fields that have `readonly` set to `true`. Users cannot edit read only fields. For more information, see [readonly](/reference/custom-resource-config#readonly) in _Config_.
Copy link
Member

Choose a reason for hiding this comment

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

I hate this readonly and hidden stuff—it confuses me so much. But looking at the table for randomstring, it seems like readonly true is what makes it persistent. False is ephemeral. So just wondering if this should be "remove the false ones."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This content is old enough that I'll make a separate docs story to investigate/confirm... I'm not even sure if the reason that this bullet point appears here actually has to do with ephemeral/persistent values or if it's more like "don't imply to your users that they can set a value for read-only fields"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sidebars.js Outdated Show resolved Hide resolved
docs/enterprise/installing-existing-cluster-automation.mdx Outdated Show resolved Hide resolved
@paigecalvert
Copy link
Contributor Author

@ajp-io thank you! comments addressed and also linked to a followup story for that readonly value item

@paigecalvert paigecalvert merged commit b87b837 into main Nov 19, 2024
5 checks passed
@paigecalvert paigecalvert deleted the 116024 branch November 19, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants