replicatedhq / kots.io

Docs site for KOTS

kots.io

As of March 8, 2022, the kots.io documentation is no longer maintained on this site. For up-to-date documentation, see docs.replicated.com.

To update the documentation or release notes for KOTS, submit a PR to the docs.replicated.com site at https://github.com/replicatedhq/replicated-docs.

kots.io's Issues

Helm Native Docs for vendors should probably swap "packaging" for "installing"

kots.io/content/vendor/helm/using-native-helm-charts.md

Line 4 in ef80348

title: Installing with Native Helm

Helm Chart guide missing docs for manually creating a HelmChart kotsKind

The docs only capture the drag-and-drop approach using the UI. We probably need an article on how to create a HelmChart CR for CLI usage in a repo based on https://github.com/replicatedhq/replicated-starter-kots.

Pinging @austinchambers on this but feel free to route as needed.

specify which commands require -n namespace

the commands on this page (and their detail pages) should list the ones that require a namespace to run properly https://kots.io/kots-cli/getting-started/

Short Code for notes/callouts?

Hi @GraysonNull @breezybaldwin I have a quick question -- in help.replicated.com we have a shortcode for notes/callouts, which supports both "info" and "warning" type notes:

and can be invoked with something like:

{{< note title="Initial Install Only" >}}
A file at `/etc/replicated.conf` will only be read on initial startup. It will never be written to, and once initial setup is complete and a license is installed, it will never be read again. (There are some exceptions to this rule, like changing the `DaemonAuthenticationPassword`, but in general it is not recommended to use `/etc/replicated.conf` after initial install).
{{< /note >}}

Would it be possible to design/provide something similar for kots.io ? (does this already exist and I don't know about it?

Clicking "Vendor Documentation" takes user to default Vendor page, not the "Links and Buttons" page

To Repro:

1. Click "Vendor Documentation"
   Expected: You're taken to the default Vendor documentation page (i.e., Overview)
   Actual: You're taken to "Links and Buttons"

HTML check failing due to rendered Span usage

https://github.com/replicatedhq/kots.io/pull/149/checks?check_run_id=550323101#step:6:453

@austinchambers is there a way to disable checking this rule? I really like the HTML linting so far, happy to help look into this but I don't know this tool well.

KOTS Snapshots documentation suggests using opt-in for volume backups, which only works with Restic

Step 2 of https://kots.io/vendor/snapshots/configuring-backup/ discusses using the backup.velero.io/backup-volumes annotation to opt-in for specific volumes that should be backed up. This is documented under https://velero.io/docs/v1.7/restic/#using-opt-in-pod-volume-backup (which is Restic specific).

We're using GCP and the https://github.com/vmware-tanzu/velero-plugin-for-gcp plugin, and seeing all PVCs have volume snapshots created and restored despite only labeling a few specific volumes with the prior annotation. The behavior of plugins seems to be: if a PVC is included in the Velero backup, it will have a volume snapshot created for it that is later used during restores. This seems to interfere with our database backup/restore process, and has resulted in incomplete backups being restored.

My understanding of https://velero.io/docs/v1.7/resource-filtering/#veleroioexclude-from-backuptrue is that if we don't want to have volume snapshots created for a specific PVC, we need to explicitly include this label. That would be worth calling out as an explicit use-case in Step 3 of https://kots.io/vendor/snapshots/configuring-backup/, as it wasn't clear from those docs that plugins would create volume snapshots for all PVCs irrespective of Restic integration.