Skip to content

Commit

Permalink
Merge pull request #2941 from replicatedhq/sdk-ga
Browse files Browse the repository at this point in the history
HOLD FOR GA: Remove SDK Beta labels
  • Loading branch information
paigecalvert authored Jan 6, 2025
2 parents 6b682fd + 1eb0936 commit 1338eb8
Show file tree
Hide file tree
Showing 13 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/partials/replicated-sdk/_dependency-yaml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/reference/replicated-sdk-apis.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/vendor/licenses-reference-sdk.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/replicated-sdk-airgap.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/replicated-sdk-customizing.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/vendor/replicated-sdk-development.mdx
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/vendor/replicated-sdk-installing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions docs/vendor/replicated-sdk-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@ 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.

## Overview

<SDKOverview/>

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

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_.

Expand All @@ -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`.
2 changes: 1 addition & 1 deletion docs/vendor/tutorial-config-package-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
2 changes: 1 addition & 1 deletion docs/vendor/tutorial-embedded-cluster-package-chart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
2 changes: 1 addition & 1 deletion docs/vendor/tutorial-kots-helm-package-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ const config = {
{
type: 'doc',
docId: 'vendor/replicated-sdk-overview',
label: 'Replicated SDK (Beta)',
label: 'Replicated SDK',
},
{
type: 'doc',
Expand All @@ -176,7 +176,7 @@ const config = {
{
type: 'doc',
docId: 'reference/replicated-sdk-apis',
label: 'Replicated SDK API (Beta)',
label: 'Replicated SDK API',
},
{
type: 'doc',
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Replicated SDK (Beta)',
label: 'Replicated SDK',
items: [
'vendor/replicated-sdk-overview',
'vendor/replicated-sdk-installing',
Expand Down

0 comments on commit 1338eb8

Please sign in to comment.