You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/partials/replicated-sdk/_dependency-yaml.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
dependencies:
4
4
- name: replicated
5
5
repository: oci://registry.replicated.com/library
6
-
version: 1.0.0-beta.32
6
+
version: 1.0.0
7
7
```
8
8
9
9
For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub.
Copy file name to clipboardExpand all lines: docs/vendor/licenses-reference-sdk.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Querying Entitlements with the Replicated SDK API (Beta)
1
+
# Querying Entitlements with the Replicated SDK API
2
2
3
3
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.
4
4
@@ -11,7 +11,7 @@ After the Replicated SDK is initialized and running in a customer environment, y
11
11
*`/api/v1/license/fields`: List all the fields in the license.
12
12
*`/api/v1/license/fields/{field_name}`: List details about a specific license field, including the field name, description, type, and the value.
13
13
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_.
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).
6
6
7
7
## Install the SDK in Integration Mode
8
8
@@ -31,7 +31,7 @@ To port forward the SDK API service to your local machine:
31
31
curl localhost:3000/api/v1/license/fields/{field}
32
32
```
33
33
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).
35
35
36
36
:::note
37
37
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.
This topic describes the methods for distributing and installing the Replicated SDK.
9
9
@@ -89,7 +89,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati
89
89
```
90
90
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.
91
91
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`.
93
93
94
94
For more information and additional options, see [Helm Pull](https://helm.sh/docs/helm/helm_pull/) in the Helm documentation.
95
95
@@ -117,7 +117,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati
117
117
name: replicated
118
118
# for chartversion, enter the version of the
119
119
# SDK Helm chart in the release
120
-
chartVersion: 1.0.0-beta.32
120
+
chartVersion: 1.0.0
121
121
```
122
122
123
123
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:
Copy file name to clipboardExpand all lines: docs/vendor/replicated-sdk-overview.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,23 @@ import SDKOverview from "../partials/replicated-sdk/_overview.mdx"
2
2
import HelmDiagramOverview from "../partials/helm/_helm-diagram-overview.mdx"
3
3
import DependencyYaml from "../partials/replicated-sdk/_dependency-yaml.mdx"
4
4
5
-
# About the Replicated SDK (Beta)
5
+
# About the Replicated SDK
6
6
7
7
This topic provides an introduction to using the Replicated SDK with your application.
8
8
9
9
## Overview
10
10
11
11
<SDKOverview/>
12
12
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).
14
14
15
15
## Limitations
16
16
17
17
The Replicated SDK has the following limitations:
18
18
19
19
* 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`:
20
20
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_.
22
22
23
23
* 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_.
24
24
@@ -28,4 +28,4 @@ At startup and when serving requests, the SDK retrieves and caches the latest in
28
28
29
29
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.
30
30
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`.
0 commit comments