Convert headings to sentence-case#3875
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| ::: | ||
|
|
||
| ## About Firewalld Configuration | ||
| ## About firewalld configuration |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'firewalld'?
| For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_. | ||
|
|
||
| ## Install Velero and Configure Host Path Storage in Air Gapped Environments | ||
| ## Install Velero and configure host path storage in air gapped environments |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'air-gapped' instead of 'air gapped'.
| For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_. | ||
|
|
||
| ## Install Velero and Configure Host Path Storage in Air Gapped Environments | ||
| ## Install Velero and configure host path storage in air gapped environments |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'gapped'?
| If no Velero installation is detected, instructions are displayed to install Velero and configure the storage destination. | ||
|
|
||
| ## Configure S3-Compatible Storage for Air Gapped Environments | ||
| ## Configure s3-compatible storage for air gapped environments |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'air-gapped' instead of 'air gapped'.
| If no Velero installation is detected, instructions are displayed to install Velero and configure the storage destination. | ||
|
|
||
| ## Configure S3-Compatible Storage for Air Gapped Environments | ||
| ## Configure s3-compatible storage for air gapped environments |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'gapped'?
| You might get an error message stating that there are no matches for the server version. This is acceptable, as long as you get a confirmation for the client version. After the Velero installation, you also see the server version. | ||
|
|
||
| ## Install the Velero CLI in an Air Gapped Cluster | ||
| ## Install the Velero CLI in an air gapped cluster |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'air-gapped' instead of 'air gapped'.
| You might get an error message stating that there are no matches for the server version. This is acceptable, as long as you get a confirmation for the client version. After the Velero installation, you also see the server version. | ||
|
|
||
| ## Install the Velero CLI in an Air Gapped Cluster | ||
| ## Install the Velero CLI in an air gapped cluster |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'gapped'?
| | Add a CA Certificate | (Optional) Upload a third-party issued (proxy) CA certificate used for trusting the authenticity of the snapshot storage endpoint. Only one file can be uploaded. However, it is possible to concatenate multiple certificates into one file. **Formats:** PEM, CER, CRT, CA, and KEY | | ||
|
|
||
| ### GCP Fields | ||
| ### GCP fields |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'GCP' on first use, if it's unfamiliar to the audience.
| ## Snapshot restore is failing | ||
|
|
||
| ### Service NodePort is Already Allocated | ||
| ### Service nodeport is already allocated |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'nodeport'?
| For more infromation about the fix, see https://github.com/kubernetes/kubernetes/pull/89937. | ||
|
|
||
| ### Partial Snapshot Restore is Stuck in Progress | ||
| ### Partial snapshot restore is stuck in progress |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is stuck').
| import CheckVersion from "../partials/snapshots/_checkVersion.mdx" | ||
|
|
||
| # Configure an NFS Storage Destination | ||
| # Configure an NFS storage destination |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'NFS' on first use, if it's unfamiliar to the audience.
| For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_. | ||
|
|
||
| ## Install Velero and Configure NFS Storage in Air Gapped Environments | ||
| ## Install Velero and configure NFS storage in air gapped environments |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'air-gapped' instead of 'air gapped'.
| For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_. | ||
|
|
||
| ## Install Velero and Configure NFS Storage in Air Gapped Environments | ||
| ## Install Velero and configure NFS storage in air gapped environments |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'gapped'?
| | Add a CA Certificate | (Optional) Upload a third-party issued (proxy) CA certificate used for trusting the authenticity of the snapshot storage endpoint. Only one file can be uploaded. However, it is possible to concatenate multiple certificates into one file. **Formats:** PEM, CER, CRT, CA, and KEY | | ||
|
|
||
| ### NFS Fields | ||
| ### NFS fields |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'NFS' on first use, if it's unfamiliar to the audience.
| This topic describes how to verify the authenticity and integrity of Replicated SDK container images using SLSA provenance, image signatures, and Software Bill of Materials (SBOM) attestations. | ||
|
|
||
| ## About Supply Chain Levels for Software Artifacts (SLSA) | ||
| ## About supply chain levels for software artifacts (SLSA) |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'SLSA' on first use, if it's unfamiliar to the audience.
| The environment is displayed in the list on the Compatibility Matrix **Overview** page with a status of Assigned. When the environment is ready, the status is changed to Running. | ||
|
|
||
| ## Create Air-Gapped Environments (Beta) {#air-gap} | ||
| ## Create air-gapped environments (Beta) {#air-gap} |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'air-gapped' or 'air gap' instead of 'air-gap'.
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/vendor/kots-faq.mdx|86 col 30| [Vale.Spelling] Did you really mean 'faqs'?
docs/vendor/kots-faq.mdx|146 col 19| [Vale.Spelling] Did you really mean 'faqs'?
docs/vendor/kots-faq.mdx|172 col 18| [Vale.Spelling] Did you really mean 'faqs'?
docs/vendor/licenses-referencing-fields.md|1 col 25| [Vale.Spelling] Did you really mean 'preflights'?
docs/vendor/licenses-referencing-fields.md|11 col 8| [Vale.Spelling] Did you really mean 'preflights'?
docs/vendor/packaging-air-gap-excluding-minio.md|1 col 11| [Vale.Spelling] Did you really mean 'minio'?
docs/vendor/operator-defining-additional-namespaces.md|1 col 21| [Vale.Spelling] Did you really mean 'namespaces'?
docs/vendor/packaging-public-images.mdx|31 col 22| [Vale.Spelling] Did you really mean 'dockerhub'?
docs/vendor/policies-infrastructure-and-subprocessors.md|2 col 22| [Vale.Spelling] Did you really mean 'subprocessor'?
docs/vendor/packaging-installer-storage.mdx|27 col 5| [Vale.Spelling] Did you really mean 'Rqlite'?
docs/vendor/packaging-installer-storage.mdx|27 col 12| [Vale.Spelling] Did you really mean 'statefulset'?
docs/vendor/packaging-installer-storage.mdx|33 col 29| [Vale.Spelling] Did you really mean 'pv'?
docs/vendor/packaging-installer-storage.mdx|59 col 5| [Vale.Spelling] Did you really mean 'Openebs'?
docs/vendor/packaging-installer-storage.mdx|98 col 5| [Vale.Spelling] Did you really mean 'Openebs'?
docs/vendor/packaging-installer-storage.mdx|98 col 18| [Vale.Spelling] Did you really mean 'minio'?
docs/vendor/packaging-installer-storage.mdx|131 col 10| [Vale.Spelling] Did you really mean 'ceph'?
docs/vendor/preflight-defining.mdx|106 col 47| [Vale.Spelling] Did you really mean 'Preflights'?
docs/vendor/preflight-examples.mdx|157 col 23| [Replicated.Passive] In general, use active voice instead of passive voice ('are met').
docs/vendor/preflight-examples.mdx|175 col 16| [Vale.Spelling] Did you really mean 'cpu'?
docs/vendor/private-images-tags-digests.md|34 col 59| [Replicated.WordSwaps] Use 'air-gapped' or 'air gap' instead of 'air-gap'.
docs/vendor/preflight-support-bundle-about.mdx|62 col 16| [Vale.Spelling] Did you really mean 'preflights'?
docs/vendor/preflight-support-bundle-about.mdx|72 col 14| [Vale.Spelling] Did you really mean 'preflights'?
docs/vendor/preflight-support-bundle-about.mdx|78 col 50| [Vale.Spelling] Did you really mean 'Preflights'?
docs/vendor/preflight-support-bundle-about.mdx|84 col 13| [Vale.Spelling] Did you really mean 'preflights'?
docs/vendor/replicated-sdk-installing.mdx|18 col 25| [Vale.Spelling] Did you really mean 'subchart'?
docs/vendor/resources-annotations-templating.md|162 col 39| [Vale.Spelling] Did you really mean 'templated'?
docs/vendor/security-center-about.mdx|17 col 17| [Replicated.Passive] In general, use active voice instead of passive voice ('are scanned').
docs/vendor/snapshots-overview.mdx|91 col 15| [Replicated.Passive] In general, use active voice instead of passive voice ('is backed').
docs/vendor/replicated-sdk-customizing.mdx|354 col 19| [Vale.Spelling] Did you really mean 'serviceaccount'?
docs/vendor/replicated-sdk-customizing.mdx|371 col 19| [Vale.Spelling] Did you really mean 'clusterrole'?
docs/vendor/replicated-sdk-customizing.mdx|426 col 13| [Vale.Spelling] Did you really mean 'configmap'?
docs/vendor/replicated-sdk-customizing.mdx|460 col 8| [Vale.Spelling] Did you really mean 'tolerations'?
docs/vendor/replicated-sdk-customizing.mdx|507 col 5| [Vale.Spelling] Did you really mean 'Commonlabels'?
docs/vendor/replicated-sdk-customizing.mdx|522 col 5| [Vale.Spelling] Did you really mean 'Podlabels'?
docs/vendor/team-management-github-username.mdx|6 col 10| [Vale.Spelling] Did you really mean 'collab'?
docs/vendor/team-management-github-username.mdx|34 col 21| [Vale.Spelling] Did you really mean 'collab'?
docs/vendor/team-management-saml-auth.md|1 col 10| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|5 col 16| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|29 col 14| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|39 col 25| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|47 col 15| [Vale.Spelling] Did you really mean 'okta'?
docs/vendor/team-management-saml-auth.md|108 col 12| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|131 col 12| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|1 col 10| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|49 col 5| [Vale.Spelling] Did you really mean 'Okta'?
docs/vendor/team-management-scim-provisioning.mdx|62 col 21| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|184 col 13| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|186 col 10| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|237 col 5| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/testing-ingress.md|161 col 44| [Vale.Spelling] Did you really mean 'loadbalancer'?
docs/vendor/testing-pricing.mdx|292 col 5| [Replicated.Acronyms] Spell out 'GCP' on first use, if it's unfamiliar to the audience.
docs/vendor/testing-vm-create.md|201 col 15| [Vale.Spelling] Did you really mean 'scp'?
docs/vendor/using-third-party-registry-proxy.mdx|68 col 8| [Vale.Spelling] Did you really mean 'Artifactory'?
docs/vendor/tutorial-ecr-private-images.md|1 col 19| [Replicated.Acronyms] Spell out 'ECR' on first use, if it's unfamiliar to the audience.
docs/vendor/tutorial-adding-db-config.md|223 col 27| [Vale.Spelling] Did you really mean 'statefulset'?
| ``` | ||
|
|
||
| ### Currently Active Clusters | ||
| ### Currently active clusters |
There was a problem hiding this comment.
[Replicated.Timeless] Avoid temporal words like 'Currently'.
| ``` | ||
|
|
||
| ### Currently Active Virtual Machines | ||
| ### Currently active virtual machines |
There was a problem hiding this comment.
[Replicated.Timeless] Avoid temporal words like 'Currently'.
| [View a larger version of this image](/images/gitea-open-app.png) | ||
|
|
||
| ## Example: NGINX Application with ClusterIP and NodePort Services | ||
| ## Example: Nginx application with clusterip and nodeport services |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'clusterip'?
| [View a larger version of this image](/images/gitea-open-app.png) | ||
|
|
||
| ## Example: NGINX Application with ClusterIP and NodePort Services | ||
| ## Example: Nginx application with clusterip and nodeport services |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'nodeport'?
| The SDK API custom metrics endpoint is available at `http://replicated:3000/api/v1/app/custom-metrics`. | ||
|
|
||
| ### NodeJS Example | ||
| ### Nodejs example |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Nodejs'?
| import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" | ||
|
|
||
| # Replicated FAQs | ||
| # Replicated faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| This topic lists frequently-asked questions (FAQs) for different components of the Replicated Platform. | ||
|
|
||
| ## Getting Started FAQs | ||
| ## Getting started faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| * [Installing and Updating with Helm in Air Gap Environments](/vendor/helm-install-airgap) | ||
|
|
||
| ### What is the Commercial Sotware Distribution Lifecycle? | ||
| ### What is the commercial sotware distribution lifecycle? |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'sotware'?
| For more information about the Replicated features that enhance each phase of the lifecycle, see [Introduction to Replicated](../intro-replicated). | ||
|
|
||
| ## Compatibility Matrix FAQs | ||
| ## Compatibility matrix faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| To create clusters with CMX, you must have credits in your Vendor Portal account. If you have a contract, you can purchase credits by logging in to the Vendor Portal and going to **[Compatibility Matrix > Buy additional credits](https://vendor.replicated.com/compatibility-matrix)**. Otherwise, to request credits, log in to the Vendor Portal and go to **[Compatibility Matrix > Request more credits](https://vendor.replicated.com/compatibility-matrix)**. | ||
|
|
||
| ### How do I add Comaptibility Matrix to my CI/CD pipelines? | ||
| ### How do i add comaptibility matrix to my CI/CD pipelines? |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'comaptibility'?
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/vendor/replicated-sdk-customizing.mdx|426 col 13| [Vale.Spelling] Did you really mean 'configmap'?
docs/vendor/replicated-sdk-customizing.mdx|460 col 8| [Vale.Spelling] Did you really mean 'tolerations'?
docs/vendor/replicated-sdk-customizing.mdx|507 col 5| [Vale.Spelling] Did you really mean 'Commonlabels'?
docs/vendor/replicated-sdk-customizing.mdx|522 col 5| [Vale.Spelling] Did you really mean 'Podlabels'?
docs/vendor/snapshots-overview.mdx|91 col 15| [Replicated.Passive] In general, use active voice instead of passive voice ('is backed').
docs/vendor/team-management-github-username.mdx|6 col 10| [Vale.Spelling] Did you really mean 'collab'?
docs/vendor/team-management-github-username.mdx|34 col 21| [Vale.Spelling] Did you really mean 'collab'?
docs/vendor/team-management-saml-auth.md|1 col 10| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|5 col 16| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|29 col 14| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|39 col 25| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|47 col 15| [Vale.Spelling] Did you really mean 'okta'?
docs/vendor/team-management-saml-auth.md|108 col 12| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-saml-auth.md|131 col 12| [Replicated.Acronyms] Spell out 'SAML' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|1 col 10| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|49 col 5| [Vale.Spelling] Did you really mean 'Okta'?
docs/vendor/team-management-scim-provisioning.mdx|62 col 21| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|184 col 13| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|186 col 10| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/team-management-scim-provisioning.mdx|237 col 5| [Replicated.Acronyms] Spell out 'SCIM' on first use, if it's unfamiliar to the audience.
docs/vendor/testing-ingress.md|161 col 44| [Vale.Spelling] Did you really mean 'loadbalancer'?
docs/vendor/testing-pricing.mdx|292 col 5| [Replicated.Acronyms] Spell out 'GCP' on first use, if it's unfamiliar to the audience.
docs/vendor/testing-vm-create.md|201 col 15| [Vale.Spelling] Did you really mean 'scp'?
docs/vendor/tutorial-ecr-private-images.md|1 col 19| [Replicated.Acronyms] Spell out 'ECR' on first use, if it's unfamiliar to the audience.
docs/vendor/using-third-party-registry-proxy.mdx|68 col 8| [Vale.Spelling] Did you really mean 'Artifactory'?
docs/vendor/tutorial-adding-db-config.md|223 col 27| [Vale.Spelling] Did you really mean 'statefulset'?
| If port 30000 is occupied, you can select a different port for the Admin Console during installation. For more information, see [install](/reference/embedded-cluster-install). | ||
|
|
||
| #### LAM Port | ||
| #### LAM port |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'LAM' on first use, if it's unfamiliar to the audience.
| For more information, see [About Integrating with CI/CD](/vendor/ci-overview). | ||
|
|
||
| ## KOTS and Embedded Cluster FAQs | ||
| ## KOTS and Embedded Cluster faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| For more information, see [Use Custom Domains](/vendor/custom-domains-using). | ||
|
|
||
| ## Replicated SDK FAQs | ||
| ## Replicated SDK faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| For more information about the SDK installation options, see [Install the Replicated SDK](/vendor/replicated-sdk-installing). | ||
|
|
||
| ## Vendor Portal FAQs | ||
| ## Vendor Portal faqs |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'faqs'?
| @@ -1,4 +1,4 @@ | |||
| # Check Entitlements in Preflights with KOTS Template Functions | |||
| # Check entitlements in preflights with KOTS template functions | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'preflights'?
| <KotsVerReq/> | ||
|
|
||
| ## Install the SDK as a Subchart | ||
| ## Install the SDK as a subchart |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'subchart'?
| ``` | ||
|
|
||
| ### Include Conditional Statements in Templated Annotations | ||
| ### Include conditional statements in templated annotations |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'templated'?
| Additionally, if there is an update to any image digests associated with an existing release, the Security Center automatically regenerates the SBOM for the relevant release version, which updates calculated CVEs as well. This means that it is not necessary to promote a new release in the Replicated Platform to get an up-to-date SBOM or CVE report in the Security Center. | ||
|
|
||
| ### What Images Are Scanned and Cataloged? | ||
| ### What images are scanned and cataloged? |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are scanned').
| * For any Service resources used as status informers, the SDK requires `get` permissions for Endpoint resources with the same name as the service. | ||
|
|
||
| #### Use a Custom ServiceAccount | ||
| #### Use a custom serviceaccount |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'serviceaccount'?
| For more information about installing with Helm, see [Install with Helm](/vendor/install-with-helm). | ||
|
|
||
| #### Use a Custom ClusterRole | ||
| #### Use a custom clusterrole |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'clusterrole'?
| When installing the Replicated SDK behind a proxy server that terminates TLS and injects a custom certificate, you must provide the CA to the SDK. This can be done by storing the CA in a ConfigMap or a Secret prior to installation and providing appropriate values during installation. | ||
|
|
||
| ### Using a ConfigMap | ||
| ### Using a configmap |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'configmap'?
| ``` | ||
|
|
||
| ## Add Tolerations | ||
| ## Add tolerations |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'tolerations'?
| The `replicated.commonLabels` and `replicated.podLabels` values are available with the Replicated SDK version 1.1.0 and later. | ||
|
|
||
| ### commonLabels | ||
| ### Commonlabels |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Commonlabels'?
| ``` | ||
|
|
||
| ### podLabels | ||
| ### Podlabels |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Podlabels'?
| For information about how to configure backup storage destinations for snapshots, see the [Configuring Backup Storage](/enterprise/snapshots-velero-cli-installing) section. | ||
|
|
||
| ### What Data is Backed Up? | ||
| ### What data is backed up? |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is backed').
| </table> | ||
|
|
||
| ### GCP GKE Cluster Pricing | ||
| ### GCP GKE cluster pricing |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'GCP' on first use, if it's unfamiliar to the audience.
| You can copy files to a VM either using direct SSH and an SCP endpoint, or by using SCP after connecting to the VM with the CMX Forwarder. Transferring files using direct SSH allows you to use your SSH tool of choice, and pass any client-supported flags. | ||
|
|
||
| ### Using the SCP Endpoint | ||
| ### Using the scp endpoint |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'scp'?
| @@ -1,4 +1,4 @@ | |||
| # Tutorial: Using ECR for Private Images | |||
| # Tutorial: Using ECR for private images | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'ECR' on first use, if it's unfamiliar to the audience.
| 1. Create a **pull-based** replication rule in Harbor to mirror images proactively. For more information, see [Creating a replication rule](https://goharbor.io/docs/2.11.0/administration/configuring-replication/create-replication-rules/) in the Harbor documentation. | ||
|
|
||
| ## Use Artifactory for Pull-Through Proxy Caching | ||
| ## Use Artifactory for pull-through proxy caching |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Artifactory'?
| To implement the embedded Database option, we'll add a Kubernetes [Statefulset](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/), and use the [annotations for optional resources](packaging-include-resources/) to control when it will be included in the application. | ||
|
|
||
| ### Adding the Secret and StatefulSet | ||
| ### Adding the secret and statefulset |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'statefulset'?
| @@ -1,4 +1,4 @@ | |||
| # Cron Expressions | |||
| # Cron expressions | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Cron'?
| <NeComparison/> | ||
|
|
||
| ### Logical AND Comparison | ||
| ### Logical AND comparison |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'AND' on first use, if it's unfamiliar to the audience.
| The [nindent](https://masterminds.github.io/sprig/strings.html) function can be used to prepend a new line to the beginning of the string and indent the string by a specified number of spaces. | ||
|
|
||
| #### Indent Templated Helm Chart Values | ||
| #### Indent templated Helm chart values |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'templated'?
| ``` | ||
|
|
||
| #### Indent Templated Annotations in Manifest Files | ||
| #### Indent templated annotations in manifest files |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'templated'?
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/vendor/support-bundle-customizing.mdx|21 col 1| [Replicated.Headings] 'Kubernetes secret *********' should use sentence case.
docs/vendor/support-bundle-examples.mdx|73 col 4| [Replicated.Headings] 'Check node resources' should use sentence case.
docs/vendor/support-bundle-examples.mdx|88 col 4| [Replicated.Headings] 'Check node status' should use sentence case.
docs/vendor/testing-cluster-addons.md|1 col 3| [Replicated.Headings] 'CMX cluster add-ons (Alpha)' should use sentence case.
docs/vendor/testing-cluster-addons.md|18 col 5| [Replicated.Headings] 'Object-store (Alpha)' should use sentence case.
docs/vendor/team-management-scim-provisioning.mdx|1 col 3| [Replicated.Headings] 'Manage SCIM provisioning (Beta)' should use sentence case.
docs/vendor/team-management-scim-provisioning.mdx|128 col 5| [Replicated.Headings] '(Recommended) Automatic user matching' should use sentence case.
| * When removing a multi-node cluster, run `reset` on each of the worker nodes first. Then, run `reset` on controller nodes. Controller nodes also remove themselves from etcd membership. | ||
|
|
||
| ### Reset a Node | ||
| ### Reset a node |
There was a problem hiding this comment.
[Replicated.Headings] 'Reset a node' should use sentence case.
| Additionally, if the application uses a large amount of memory, you can configure the default memory limit to help ensure that Velero runs successfully with snapshots. | ||
|
|
||
| ## Configure Namespace Access | ||
| ## Configure namespace access |
There was a problem hiding this comment.
[Replicated.Headings] 'Configure namespace access' should use sentence case.
| ::: | ||
|
|
||
| ### Memory Limit Reached on the node-agent Pod | ||
| ### Memory limit reached on the node-agent pod |
There was a problem hiding this comment.
[Replicated.Headings] 'Memory limit reached on the node-agent pod' should use sentence case.
| @@ -1,4 +1,4 @@ | |||
| # Preflight and Support Bundle | |||
| # Preflight and SupportBundle | |||
There was a problem hiding this comment.
[Replicated.Headings] 'Preflight and SupportBundle' should use sentence case.
| ``` | ||
|
|
||
| ### Headless (Automated) Install | ||
| ### Headless (Automated) install |
There was a problem hiding this comment.
[Replicated.Headings] 'Headless (Automated) install' should use sentence case.
| For more information, see the [Analyze](https://troubleshoot.sh/docs/analyze/) section in the Troubleshoot documentation. | ||
|
|
||
| ## Preflight Checks | ||
| ## Preflight checks |
There was a problem hiding this comment.
[Replicated.Headings] 'Preflight checks' should use sentence case.
| - **Embedded Cluster images**: Any infrastructure images used by Replicated Embedded Cluster installations, if relevant. | ||
|
|
||
| ### How CVE Scanning Works | ||
| ### How cve scanning works |
There was a problem hiding this comment.
[Replicated.Headings] 'How cve scanning works' should use sentence case.
| * Fixed versions (when available) | ||
|
|
||
| ### Release-Specific CVE Information | ||
| ### Release-specific cve information |
There was a problem hiding this comment.
[Replicated.Headings] 'Release-specific cve information' should use sentence case.
| CVE details are available for all current and previously promoted application release versions. To view CVE information for a specifc release, go to **Releases > [Release Version] > Security**. | ||
|
|
||
| ### Customer-Specific CVE Information | ||
| ### Customer-specific cve information |
There was a problem hiding this comment.
[Replicated.Headings] 'Customer-specific cve information' should use sentence case.
| ::: | ||
|
|
||
| ### Using a Secret | ||
| ### Using a secret |
There was a problem hiding this comment.
[Replicated.Headings] 'Using a secret' should use sentence case.
| Finally, the diagram shows how [**instance data**](/vendor/instance-insights-event-data) is automatically sent from the customer environment to the Vendor Portal by the Replicated SDK API and the KOTS Admin Console. Additionally, tooling from the open source [**Troubleshoot**](https://troubleshoot.sh/docs/collect/) project is used to generate and send [**support bundles**](/vendor/preflight-support-bundle-about), which include logs and other important diagnostic data. | ||
|
|
||
| ## Replicated Platform Features | ||
| ## Replicated Platform features |
There was a problem hiding this comment.
[Replicated.Headings] 'Replicated Platform features' should use sentence case.
| 1. Delete the cluster when the tests complete. See the [cluster rm](/reference/replicated-cli-cluster-rm) Replicated CLI command. Or, for GitHub Actions workflows, see the [remove-cluster](https://github.com/replicatedhq/replicated-actions/tree/main/remove-cluster) action. | ||
|
|
||
| ## Replicated Platform Release Workflow | ||
| ## Replicated Platform release workflow |
There was a problem hiding this comment.
[Replicated.Headings] 'Replicated Platform release workflow' should use sentence case.
| import WriteYourDocs from "../partials/getting-started/_write-your-docs.mdx" | ||
|
|
||
| # Onboard to the Replicated Platform (Helm CLI Installs Only) | ||
| # Onboard to the Replicated Platform (Helm CLI installs only) |
There was a problem hiding this comment.
[Replicated.Headings] 'Onboard to the Replicated Platform (Helm CLI installs only)' should use sentence case.
| * **Kubernetes Manifest-Based Applications**: For Kubernetes manifest-based applications, create the support bundle spec in a Preflight custom resource. See [SupportBundle Custom Resource](#sb-cr). | ||
|
|
||
| ### Kubernetes Secret {#secret} | ||
| ### Kubernetes secret {#secret} |
There was a problem hiding this comment.
[Replicated.Headings] 'Kubernetes secret *********' should use sentence case.
| </Tabs> | ||
|
|
||
| ## Check Node Resources | ||
| ## Check node resources |
There was a problem hiding this comment.
[Replicated.Headings] 'Check node resources' should use sentence case.
| </Tabs> | ||
|
|
||
| ## Check Node Status | ||
| ## Check node status |
There was a problem hiding this comment.
[Replicated.Headings] 'Check node status' should use sentence case.
| @@ -1,4 +1,4 @@ | |||
| # CMX Cluster Add-ons (Alpha) | |||
| # CMX cluster add-ons (Alpha) | |||
There was a problem hiding this comment.
[Replicated.Headings] 'CMX cluster add-ons (Alpha)' should use sentence case.
| This section lists the supported cluster add-ons for clusters created with CMX. | ||
|
|
||
| ### object-store (Alpha) | ||
| ### Object-store (Alpha) |
There was a problem hiding this comment.
[Replicated.Headings] 'Object-store (Alpha)' should use sentence case.
| @@ -1,4 +1,4 @@ | |||
| # Manage SCIM Provisioning (Beta) | |||
| # Manage SCIM provisioning (Beta) | |||
There was a problem hiding this comment.
[Replicated.Headings] 'Manage SCIM provisioning (Beta)' should use sentence case.
| * Monitor for provisioning errors during the first few days. | ||
|
|
||
| ### (Recommended) Automatic User Matching | ||
| ### (Recommended) Automatic user matching |
There was a problem hiding this comment.
[Replicated.Headings] '(Recommended) Automatic user matching' should use sentence case.
No description provided.