From 2ea04defc4ac9672b510a18d30917d71745639b1 Mon Sep 17 00:00:00 2001 From: divolgin Date: Mon, 11 Nov 2024 16:00:48 -0800 Subject: [PATCH 1/4] Add deprecation note for kURL --- docs/vendor/kurl-about.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/vendor/kurl-about.mdx b/docs/vendor/kurl-about.mdx index 6f55372d91..dbe37d1f36 100644 --- a/docs/vendor/kurl-about.mdx +++ b/docs/vendor/kurl-about.mdx @@ -3,6 +3,10 @@ import Installers from "../partials/kurl/_installers.mdx" # Introduction to kURL +:::note +kURL is no longer available to new customers. Replicated Embedded Cluster is the next generation product that has superceded kURL. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). +::: + This topic provides an introduction to the Replicated kURL installer, including information about kURL specifications and installations. :::note From abb209a780ba6ca061ddaee0d84e6f77fe86c904 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 12 Nov 2024 11:09:30 -0700 Subject: [PATCH 2/4] Add note to more topics --- docs/partials/kurl/_kurl-availability.mdx | 5 +++++ docs/vendor/{installer-history.md => installer-history.mdx} | 4 ++++ docs/vendor/kots-faq.mdx | 3 +++ docs/vendor/kurl-about.mdx | 5 ++--- ...edded-kubernetes.md => packaging-embedded-kubernetes.mdx} | 3 +++ ...-installer-storage.md => packaging-installer-storage.mdx} | 4 ++++ ...ging-using-tls-certs.md => packaging-using-tls-certs.mdx} | 4 ++++ 7 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 docs/partials/kurl/_kurl-availability.mdx rename docs/vendor/{installer-history.md => installer-history.mdx} (95%) rename docs/vendor/{packaging-embedded-kubernetes.md => packaging-embedded-kubernetes.mdx} (98%) rename docs/vendor/{packaging-installer-storage.md => packaging-installer-storage.mdx} (99%) rename docs/vendor/{packaging-using-tls-certs.md => packaging-using-tls-certs.mdx} (97%) diff --git a/docs/partials/kurl/_kurl-availability.mdx b/docs/partials/kurl/_kurl-availability.mdx new file mode 100644 index 0000000000..2fdd3f28dd --- /dev/null +++ b/docs/partials/kurl/_kurl-availability.mdx @@ -0,0 +1,5 @@ +:::note +Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). + +kURL is a Generally Available (GA) product and is not deprecated. For more information about the Replicated product lifecycle phases, see [Support Lifecycle Policy](/vendor/policies-support-lifecycle). +::: \ No newline at end of file diff --git a/docs/vendor/installer-history.md b/docs/vendor/installer-history.mdx similarity index 95% rename from docs/vendor/installer-history.md rename to docs/vendor/installer-history.mdx index 4aa6cbc251..c23ed6ea93 100644 --- a/docs/vendor/installer-history.md +++ b/docs/vendor/installer-history.mdx @@ -1,5 +1,9 @@ +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" + # Installer History + + This topic describes how to access the installation commands for all active and inactive kURL installers promoted to a channel. ## About Using Inactive Installers diff --git a/docs/vendor/kots-faq.mdx b/docs/vendor/kots-faq.mdx index 456ac10109..d5a78da264 100644 --- a/docs/vendor/kots-faq.mdx +++ b/docs/vendor/kots-faq.mdx @@ -1,6 +1,7 @@ import SDKOverview from "../partials/replicated-sdk/_overview.mdx" import EmbeddedKubernetes from "../partials/kots/_embedded-kubernetes-definition.mdx" import Helm from "../partials/helm/_helm-definition.mdx" +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" # Replicated FAQs @@ -135,6 +136,8 @@ For more information, see [About Distributing Helm Charts with KOTS](/vendor/hel Replicated Embedded Cluster is a successor to Replicated kURL. Compared to kURL, Embedded Cluster feature offers significantly faster installation, updates, and node joins, a redesigned Admin Console UI, improved support for multi-node clusters, one-click updates that update the application and the cluster at the same time, and more. + + For more information, see [Using Embedded Cluster](/vendor/embedded-overview). ### How do I enable Embedded Cluster and KOTS installations for my application? diff --git a/docs/vendor/kurl-about.mdx b/docs/vendor/kurl-about.mdx index dbe37d1f36..088c93446c 100644 --- a/docs/vendor/kurl-about.mdx +++ b/docs/vendor/kurl-about.mdx @@ -1,11 +1,10 @@ import KurlDefinition from "../partials/kurl/_kurl-definition.mdx" import Installers from "../partials/kurl/_installers.mdx" +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" # Introduction to kURL -:::note -kURL is no longer available to new customers. Replicated Embedded Cluster is the next generation product that has superceded kURL. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). -::: + This topic provides an introduction to the Replicated kURL installer, including information about kURL specifications and installations. diff --git a/docs/vendor/packaging-embedded-kubernetes.md b/docs/vendor/packaging-embedded-kubernetes.mdx similarity index 98% rename from docs/vendor/packaging-embedded-kubernetes.md rename to docs/vendor/packaging-embedded-kubernetes.mdx index b949c0755b..71db85ff13 100644 --- a/docs/vendor/packaging-embedded-kubernetes.md +++ b/docs/vendor/packaging-embedded-kubernetes.mdx @@ -1,7 +1,10 @@ import Installers from "../partials/kurl/_installers.mdx" +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" # Creating a kURL Installer + + This topic describes how to create a kURL installer spec in the Replicated Vendor Portal to support installations with Replicated kURL. For information about creating kURL installers with the Replicated CLI, see [installer create](/reference/replicated-cli-installer-create). diff --git a/docs/vendor/packaging-installer-storage.md b/docs/vendor/packaging-installer-storage.mdx similarity index 99% rename from docs/vendor/packaging-installer-storage.md rename to docs/vendor/packaging-installer-storage.mdx index b15e291e8d..0064bb51b2 100644 --- a/docs/vendor/packaging-installer-storage.md +++ b/docs/vendor/packaging-installer-storage.mdx @@ -1,5 +1,9 @@ +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" + # About Selecting Storage Add-ons + + This topic provides guidance for selecting Replicated kURL add-ons to provide highly available data storage in embedded kURL clusters. For additional guidance, see [Choosing a PV Provisioner](https://kurl.sh/docs/create-installer/choosing-a-pv-provisioner) in the open source kURL documentation. ## Overview diff --git a/docs/vendor/packaging-using-tls-certs.md b/docs/vendor/packaging-using-tls-certs.mdx similarity index 97% rename from docs/vendor/packaging-using-tls-certs.md rename to docs/vendor/packaging-using-tls-certs.mdx index 145b2dd399..70db50cfcc 100644 --- a/docs/vendor/packaging-using-tls-certs.md +++ b/docs/vendor/packaging-using-tls-certs.mdx @@ -1,5 +1,9 @@ +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" + # Using TLS Certificates + + Replicated KOTS provides default self-signed certificates that renew automatically. For embedded clusters created with Replicated kURL, the self-signed certificate renews 30 days before expiration when you enable the kURL EKCO add-on version 0.7.0 and later. Custom TLS options are supported: From 59af83df1b1ea1bc8fd9202d5f8c90221daf05fe Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 12 Nov 2024 11:14:48 -0700 Subject: [PATCH 3/4] add to embedded k8s overview topic --- docs/vendor/embedded-kubernetes-overview.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/vendor/embedded-kubernetes-overview.mdx b/docs/vendor/embedded-kubernetes-overview.mdx index 83166423f1..0b70357ad5 100644 --- a/docs/vendor/embedded-kubernetes-overview.mdx +++ b/docs/vendor/embedded-kubernetes-overview.mdx @@ -2,6 +2,7 @@ import KurlDefinition from "../partials/kurl/_kurl-definition.mdx" import EmbeddedCluster from "../partials/embedded-cluster/_definition.mdx" import KurlComparison from "../partials/embedded-cluster/_kurl-comparison.mdx" import EmbeddedKubernetes from "../partials/kots/_embedded-kubernetes-definition.mdx" +import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" # About Embedded Kubernetes @@ -27,6 +28,8 @@ For more information about configuring and installing with Embedded Cluster, see ### kURL + + For more information about how to get started with kURL, see [Introduction to kURL](kurl-about). \ No newline at end of file From bb5c295d31bd0dc44432d12db493a270b94d11ba Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 12 Nov 2024 13:07:29 -0700 Subject: [PATCH 4/4] remove term deprecated --- docs/partials/kurl/_kurl-availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/partials/kurl/_kurl-availability.mdx b/docs/partials/kurl/_kurl-availability.mdx index 2fdd3f28dd..c1a13247b5 100644 --- a/docs/partials/kurl/_kurl-availability.mdx +++ b/docs/partials/kurl/_kurl-availability.mdx @@ -1,5 +1,5 @@ :::note Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). -kURL is a Generally Available (GA) product and is not deprecated. For more information about the Replicated product lifecycle phases, see [Support Lifecycle Policy](/vendor/policies-support-lifecycle). +kURL is a Generally Available (GA) product for existing customers. For more information about the Replicated product lifecycle phases, see [Support Lifecycle Policy](/vendor/policies-support-lifecycle). ::: \ No newline at end of file