diff --git a/docs/partials/replicated-sdk/_dependency-yaml.mdx b/docs/partials/replicated-sdk/_dependency-yaml.mdx index 865a474e1..f43f503d4 100644 --- a/docs/partials/replicated-sdk/_dependency-yaml.mdx +++ b/docs/partials/replicated-sdk/_dependency-yaml.mdx @@ -3,7 +3,7 @@ dependencies: - name: replicated repository: oci://registry.replicated.com/library - version: 1.0.0-beta.32 + version: 1.0.0 ``` For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub. diff --git a/docs/reference/replicated-sdk-apis.md b/docs/reference/replicated-sdk-apis.md index 99706568c..3f7291dc1 100644 --- a/docs/reference/replicated-sdk-apis.md +++ b/docs/reference/replicated-sdk-apis.md @@ -1,4 +1,4 @@ -# Replicated SDK API (Beta) +# Replicated SDK API The Replicated SDK provides an API that you can use to embed Replicated functionality in your Helm chart application. diff --git a/docs/vendor/licenses-reference-sdk.mdx b/docs/vendor/licenses-reference-sdk.mdx index 76e5168dc..ae17e2846 100644 --- a/docs/vendor/licenses-reference-sdk.mdx +++ b/docs/vendor/licenses-reference-sdk.mdx @@ -1,4 +1,4 @@ -# Querying Entitlements with the Replicated SDK API (Beta) +# Querying Entitlements with the Replicated SDK API This topic describes how to query license entitlements at runtime using the Replicated SDK in-cluster API. The information in this topic applies to applications installed with Replicated KOTS or Helm. @@ -11,7 +11,7 @@ After the Replicated SDK is initialized and running in a customer environment, y * `/api/v1/license/fields`: List all the fields in the license. * `/api/v1/license/fields/{field_name}`: List details about a specific license field, including the field name, description, type, and the value. -For more information about these endpoints, see [license](/reference/replicated-sdk-apis#license) in _Replicated SDK API (Beta)_. +For more information about these endpoints, see [license](/reference/replicated-sdk-apis#license) in _Replicated SDK API_. ## Prerequisite diff --git a/docs/vendor/replicated-sdk-airgap.mdx b/docs/vendor/replicated-sdk-airgap.mdx index f077241ef..d52b913ca 100644 --- a/docs/vendor/replicated-sdk-airgap.mdx +++ b/docs/vendor/replicated-sdk-airgap.mdx @@ -1,4 +1,4 @@ -# Installing the SDK in Air Gap Environments (Beta) +# Installing the SDK in Air Gap Environments This topic explains how to install the Replicated SDK in air gap environments by enabling air gap mode. diff --git a/docs/vendor/replicated-sdk-customizing.md b/docs/vendor/replicated-sdk-customizing.md index 702e8b4b8..05533c8fa 100644 --- a/docs/vendor/replicated-sdk-customizing.md +++ b/docs/vendor/replicated-sdk-customizing.md @@ -1,4 +1,4 @@ -# Customizing the Replicated SDK (Beta) +# Customizing the Replicated SDK This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, and adding tolerations. diff --git a/docs/vendor/replicated-sdk-development.mdx b/docs/vendor/replicated-sdk-development.mdx index 4ba7ca89a..a0a2981bd 100644 --- a/docs/vendor/replicated-sdk-development.mdx +++ b/docs/vendor/replicated-sdk-development.mdx @@ -1,8 +1,8 @@ import IntegrationMode from "../partials/replicated-sdk/_integration-mode-install.mdx" -# Developing Against the SDK API (Beta) +# Developing Against the SDK API -This topic describes how to develop against the SDK API to test changes locally. It includes information about installing the SDK in integration mode and port forwarding the SDK API service to your local machine. For more information about the SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis). +This topic describes how to develop against the SDK API to test changes locally. It includes information about installing the SDK in integration mode and port forwarding the SDK API service to your local machine. For more information about the SDK API, see [Replicated SDK API](/reference/replicated-sdk-apis). ## Install the SDK in Integration Mode @@ -31,7 +31,7 @@ To port forward the SDK API service to your local machine: curl localhost:3000/api/v1/license/fields/{field} ``` - For more information, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis). + For more information, see [Replicated SDK API](/reference/replicated-sdk-apis). :::note When the SDK is installed in integration mode, requests to the `license` endpoints use your actual development license data, while requests to the `app` endpoints use the default mock data. diff --git a/docs/vendor/replicated-sdk-installing.mdx b/docs/vendor/replicated-sdk-installing.mdx index 9c78fba68..145421422 100644 --- a/docs/vendor/replicated-sdk-installing.mdx +++ b/docs/vendor/replicated-sdk-installing.mdx @@ -3,7 +3,7 @@ import KotsVerReq from "../partials/replicated-sdk/_kots-version-req.mdx" import RegistryLogout from "../partials/replicated-sdk/_registry-logout.mdx" import IntegrationMode from "../partials/replicated-sdk/_integration-mode-install.mdx" -# Installing the Replicated SDK (Beta) +# Installing the Replicated SDK This topic describes the methods for distributing and installing the Replicated SDK. @@ -89,7 +89,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati ``` Where `SDK_VERSION` is the version of the SDK to install. For a list of available SDK versions, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/tags) in GitHub. - The output of this command is a `.tgz` file with the naming convention `CHART_NAME-CHART_VERSION.tgz`. For example, `replicated-1.0.0-beta.32.tgz`. + The output of this command is a `.tgz` file with the naming convention `CHART_NAME-CHART_VERSION.tgz`. For example, `replicated-1.0.0.tgz`. For more information and additional options, see [Helm Pull](https://helm.sh/docs/helm/helm_pull/) in the Helm documentation. @@ -117,7 +117,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati name: replicated # for chartversion, enter the version of the # SDK Helm chart in the release - chartVersion: 1.0.0-beta.32 + chartVersion: 1.0.0 ``` As shown in the example above, the HelmChart custom resource requires the name and version of the SDK Helm chart that you added to the release: diff --git a/docs/vendor/replicated-sdk-overview.md b/docs/vendor/replicated-sdk-overview.md index 4223cf9af..79b17409a 100644 --- a/docs/vendor/replicated-sdk-overview.md +++ b/docs/vendor/replicated-sdk-overview.md @@ -2,7 +2,7 @@ import SDKOverview from "../partials/replicated-sdk/_overview.mdx" import HelmDiagramOverview from "../partials/helm/_helm-diagram-overview.mdx" import DependencyYaml from "../partials/replicated-sdk/_dependency-yaml.mdx" -# About the Replicated SDK (Beta) +# About the Replicated SDK This topic provides an introduction to using the Replicated SDK with your application. @@ -10,7 +10,7 @@ This topic provides an introduction to using the Replicated SDK with your applic -For more information about the Replicated SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis). For information about developing against the SDK API locally, see [Developing Against the SDK API (Beta)](replicated-sdk-development). +For more information about the Replicated SDK API, see [Replicated SDK API](/reference/replicated-sdk-apis). For information about developing against the SDK API locally, see [Developing Against the SDK API](replicated-sdk-development). ## Limitations @@ -18,7 +18,7 @@ The Replicated SDK has the following limitations: * Some popular enterprise continuous delivery tools, such as ArgoCD and Pulumi, deploy Helm charts by running `helm template` then `kubectl apply` on the generated manifests, rather than running `helm install` or `helm upgrade`. The following limitations apply to applications installed by running `helm template` then `kubectl apply`: - * The `/api/v1/app/history` SDK API endpoint always returns an empty array because there is no Helm history in the cluster. See [GET /app/history](/reference/replicated-sdk-apis#get-apphistory) in _Replicated SDK API (Beta)_. + * The `/api/v1/app/history` SDK API endpoint always returns an empty array because there is no Helm history in the cluster. See [GET /app/history](/reference/replicated-sdk-apis#get-apphistory) in _Replicated SDK API_. * The SDK does not automatically generate status informers to report status data for installed instances of the application. To get instance status data, you must enable custom status informers by overriding the `replicated.statusInformers` Helm value. See [Enable Application Status Insights](/vendor/insights-app-status#enable-application-status-insights) in _Enabling and Understanding Application Status_. @@ -28,4 +28,4 @@ At startup and when serving requests, the SDK retrieves and caches the latest in If the upstream APIs are not available at startup, the SDK does not accept connections or serve requests until it is able to communicate with the upstream APIs. If communication fails, the SDK retries every 10 seconds and the SDK pod is at `0/1` ready. -When serving requests, if the upstream APIs become unavailable, the SDK serves from the memory cache and sets the `X-Replicated-Served-From-Cache` header to `true`. Additionally, rapid sucessive requests to same SDK endpoint with the same request properties will be rate-limited returning the last cached payload and status code without reaching out to the upstream APIs. A `X-Replicated-Rate-Limited` header will set to `true`. +When serving requests, if the upstream APIs become unavailable, the SDK serves from the memory cache and sets the `X-Replicated-Served-From-Cache` header to `true`. Additionally, rapid successive requests to same SDK endpoint with the same request properties will be rate-limited returning the last cached payload and status code without reaching out to the upstream APIs. A `X-Replicated-Rate-Limited` header will set to `true`. diff --git a/docs/vendor/tutorial-config-package-chart.md b/docs/vendor/tutorial-config-package-chart.md index 8b0174bf7..eb29af612 100644 --- a/docs/vendor/tutorial-config-package-chart.md +++ b/docs/vendor/tutorial-config-package-chart.md @@ -26,5 +26,5 @@ Create a release using the Helm chart archive. See [Step 4: Add the Chart Archiv ## Related Topics -* [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview) +* [About the Replicated SDK](/vendor/replicated-sdk-overview) * [Helm Package](https://helm.sh/docs/helm/helm_package/) \ No newline at end of file diff --git a/docs/vendor/tutorial-embedded-cluster-package-chart.mdx b/docs/vendor/tutorial-embedded-cluster-package-chart.mdx index 2545baa66..ab50d16d3 100644 --- a/docs/vendor/tutorial-embedded-cluster-package-chart.mdx +++ b/docs/vendor/tutorial-embedded-cluster-package-chart.mdx @@ -47,5 +47,5 @@ Create a release using the Helm chart archive. See [Step 3: Add the Chart Archiv ## Related Topics * [Packaging a Helm Chart for a Release](/vendor/helm-install-release.md) -* [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview) +* [About the Replicated SDK](/vendor/replicated-sdk-overview) * [Helm Package](https://helm.sh/docs/helm/helm_package/) diff --git a/docs/vendor/tutorial-kots-helm-package-chart.md b/docs/vendor/tutorial-kots-helm-package-chart.md index 672ab5dc3..619e39df8 100644 --- a/docs/vendor/tutorial-kots-helm-package-chart.md +++ b/docs/vendor/tutorial-kots-helm-package-chart.md @@ -29,5 +29,5 @@ Create a release using the Helm chart archive. See [Step 4: Add the Chart Archiv ## Related Topics * [Packaging a Helm Chart for a Release](/vendor/helm-install-release.md) -* [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview) +* [About the Replicated SDK](/vendor/replicated-sdk-overview) * [Helm Package](https://helm.sh/docs/helm/helm_package/) diff --git a/docusaurus.config.js b/docusaurus.config.js index 95fda39c4..7ebe9297a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -149,7 +149,7 @@ const config = { { type: 'doc', docId: 'vendor/replicated-sdk-overview', - label: 'Replicated SDK (Beta)', + label: 'Replicated SDK', }, { type: 'doc', @@ -176,7 +176,7 @@ const config = { { type: 'doc', docId: 'reference/replicated-sdk-apis', - label: 'Replicated SDK API (Beta)', + label: 'Replicated SDK API', }, { type: 'doc', diff --git a/sidebars.js b/sidebars.js index 5d14df5d7..09f52badc 100644 --- a/sidebars.js +++ b/sidebars.js @@ -504,7 +504,7 @@ const sidebars = { }, { type: 'category', - label: 'Replicated SDK (Beta)', + label: 'Replicated SDK', items: [ 'vendor/replicated-sdk-overview', 'vendor/replicated-sdk-installing',