Skip to content

Commit 1338eb8

Browse files
authored
Merge pull request #2941 from replicatedhq/sdk-ga
HOLD FOR GA: Remove SDK Beta labels
2 parents 6b682fd + 1eb0936 commit 1338eb8

13 files changed

+22
-22
lines changed

docs/partials/replicated-sdk/_dependency-yaml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
dependencies:
44
- name: replicated
55
repository: oci://registry.replicated.com/library
6-
version: 1.0.0-beta.32
6+
version: 1.0.0
77
```
88
99
For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub.

docs/reference/replicated-sdk-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Replicated SDK API (Beta)
1+
# Replicated SDK API
22

33
The Replicated SDK provides an API that you can use to embed Replicated functionality in your Helm chart application.
44

docs/vendor/licenses-reference-sdk.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Querying Entitlements with the Replicated SDK API (Beta)
1+
# Querying Entitlements with the Replicated SDK API
22

33
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.
44

@@ -11,7 +11,7 @@ After the Replicated SDK is initialized and running in a customer environment, y
1111
* `/api/v1/license/fields`: List all the fields in the license.
1212
* `/api/v1/license/fields/{field_name}`: List details about a specific license field, including the field name, description, type, and the value.
1313

14-
For more information about these endpoints, see [license](/reference/replicated-sdk-apis#license) in _Replicated SDK API (Beta)_.
14+
For more information about these endpoints, see [license](/reference/replicated-sdk-apis#license) in _Replicated SDK API_.
1515

1616
## Prerequisite
1717

docs/vendor/replicated-sdk-airgap.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing the SDK in Air Gap Environments (Beta)
1+
# Installing the SDK in Air Gap Environments
22

33
This topic explains how to install the Replicated SDK in air gap environments by enabling air gap mode.
44

docs/vendor/replicated-sdk-customizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Customizing the Replicated SDK (Beta)
1+
# Customizing the Replicated SDK
22

33
This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, and adding tolerations.
44

docs/vendor/replicated-sdk-development.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import IntegrationMode from "../partials/replicated-sdk/_integration-mode-install.mdx"
22

3-
# Developing Against the SDK API (Beta)
3+
# Developing Against the SDK API
44

5-
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).
5+
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).
66

77
## Install the SDK in Integration Mode
88

@@ -31,7 +31,7 @@ To port forward the SDK API service to your local machine:
3131
curl localhost:3000/api/v1/license/fields/{field}
3232
```
3333

34-
For more information, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis).
34+
For more information, see [Replicated SDK API](/reference/replicated-sdk-apis).
3535

3636
:::note
3737
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.

docs/vendor/replicated-sdk-installing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import KotsVerReq from "../partials/replicated-sdk/_kots-version-req.mdx"
33
import RegistryLogout from "../partials/replicated-sdk/_registry-logout.mdx"
44
import IntegrationMode from "../partials/replicated-sdk/_integration-mode-install.mdx"
55

6-
# Installing the Replicated SDK (Beta)
6+
# Installing the Replicated SDK
77

88
This topic describes the methods for distributing and installing the Replicated SDK.
99

@@ -89,7 +89,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati
8989
```
9090
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.
9191

92-
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`.
92+
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`.
9393

9494
For more information and additional options, see [Helm Pull](https://helm.sh/docs/helm/helm_pull/) in the Helm documentation.
9595

@@ -117,7 +117,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati
117117
name: replicated
118118
# for chartversion, enter the version of the
119119
# SDK Helm chart in the release
120-
chartVersion: 1.0.0-beta.32
120+
chartVersion: 1.0.0
121121
```
122122
123123
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:

docs/vendor/replicated-sdk-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@ import SDKOverview from "../partials/replicated-sdk/_overview.mdx"
22
import HelmDiagramOverview from "../partials/helm/_helm-diagram-overview.mdx"
33
import DependencyYaml from "../partials/replicated-sdk/_dependency-yaml.mdx"
44

5-
# About the Replicated SDK (Beta)
5+
# About the Replicated SDK
66

77
This topic provides an introduction to using the Replicated SDK with your application.
88

99
## Overview
1010

1111
<SDKOverview/>
1212

13-
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).
13+
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).
1414

1515
## Limitations
1616

1717
The Replicated SDK has the following limitations:
1818

1919
* 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`:
2020

21-
* 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)_.
21+
* 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_.
2222

2323
* 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_.
2424

@@ -28,4 +28,4 @@ At startup and when serving requests, the SDK retrieves and caches the latest in
2828

2929
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.
3030

31-
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`.
31+
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`.

docs/vendor/tutorial-config-package-chart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ Create a release using the Helm chart archive. See [Step 4: Add the Chart Archiv
2626

2727
## Related Topics
2828

29-
* [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview)
29+
* [About the Replicated SDK](/vendor/replicated-sdk-overview)
3030
* [Helm Package](https://helm.sh/docs/helm/helm_package/)

docs/vendor/tutorial-embedded-cluster-package-chart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ Create a release using the Helm chart archive. See [Step 3: Add the Chart Archiv
4747
## Related Topics
4848

4949
* [Packaging a Helm Chart for a Release](/vendor/helm-install-release.md)
50-
* [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview)
50+
* [About the Replicated SDK](/vendor/replicated-sdk-overview)
5151
* [Helm Package](https://helm.sh/docs/helm/helm_package/)

0 commit comments

Comments
 (0)