Replicated

https://docs.replicated.com
Admin
Replicated is an enterprise software distribution platform that enables software vendors to package,...
Tokens:258,326
Snippets:2,401
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### cluster prepare with Helm chart (kind example)

Source: https://docs.replicated.com/vendor/testing-how-to.md

Example that creates a kind cluster and installs the `nginx-chart-0.0.14.tgz` chart. Shows additional options like `--set`, `--set-string`, `--set-json`, `--set-literal`, and `--values`.

```bash
replicated cluster prepare \
  --distribution kind \
  --version 1.27.0 \
  --chart nginx-chart-0.0.14.tgz \
  --set key1=val1,key2=val2 \
  --set-string s1=val1,s2=val2 \
  --set-json j1='{"key1":"val1","key2":"val2"}' \
  --set-literal l1=val1,l2=val2 \
  --values values.yaml
```

--------------------------------

### cluster prepare with YAML directory (k3s example)

Source: https://docs.replicated.com/vendor/testing-how-to.md

Example that creates a k3s cluster and installs an application from the `config-validation` directory. Shows additional options like `--namespace`, `--shared-password`, `--app-ready-timeout`, `--config-values-file`, and `--entitlements`.

```bash
replicated cluster prepare \
  --distribution k3s \
  --version 1.26 \
  --namespace config-validation \
  --shared-password password \
  --app-ready-timeout 10m \
  --yaml-dir config-validation \
  --config-values-file conifg-values.yaml \
  --entitlements "num_of_queues=5"
```

--------------------------------

### Example output of kubectl get deploy showing replicated Deployment

Source: https://docs.replicated.com/vendor/replicated-sdk-installing.md

Example output from 'kubectl get deploy --namespace NAMESPACE' showing the 'replicated' Deployment alongside the application Deployment, both with READY 1/1.

```text
NAME         READY   UP-TO-DATE   AVAILABLE   AGE
your-app     1/1     1            1           35s
replicated   1/1     1            1           35s

```

--------------------------------

### GET /license/info - Request

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Lists details about the license used to install, including license ID, type, customer name, and channel.

```bash
GET http://replicated:3000/api/v1/license/info
```

--------------------------------

### Install support-bundle plugin with Krew (Windows/Linux)

Source: https://docs.replicated.com/vendor/support-bundle-generating.md

For Windows and Linux users, use Krew. If krew is not installed, run the first command to install both krew and the plugin. If krew is already installed, run the second command. To upgrade, run the third command.

```bash
curl https://krew.sh/support-bundle | bash  
```

```bash
kubectl krew install support-bundle  
```

```bash
kubectl krew upgrade support-bundle  
```

--------------------------------

### kURL installation script output example

Source: https://docs.replicated.com/vendor/kurl-about.md

Example output from a kURL installation script when the KOTS add-on is included. Shows the installation complete message, the Kotsadm URL, and the default password. The password is set by default and should be changed using the kubectl kots reset-password default command.

```bash
        Installation
          Complete ✔

Kotsadm: http://10.128.0.35:8800
Login with password (will not be shown again): 3Hy8WYYid

This password has been set for you by default. It is recommended that you change
this password; this can be done with the following command:
kubectl kots reset-password default
```

--------------------------------

### GET /license/fields/{field_name} - Example Request

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Example curl request to retrieve the 'expires_at' field.

```bash
curl replicated:3000/api/v1/license/fields/expires_at
```

--------------------------------

### Example output of `replicated vm create --network`

Source: https://docs.replicated.com/vendor/testing-how-to.md

Example output showing the created VM with its network ID.

```text
ID         NAME                 DISTRIBUTION   VERSION   STATUS     NETWORK    CREATED                EXPIRES  COST  

760a30b1   suspicious_poitras   ubuntu         24.04     assigned   accbd6a7   2025-08-04 13:24 PDT   -        $0.60
```

--------------------------------

### Embedded Cluster Installation Output

Source: https://docs.replicated.com/vendor/quick-start.md

Example output after running the installation command and setting the Admin Console password.

```bash
? Set the Admin Console password (minimum 6 characters): ********
? Confirm the Admin Console password: ********

✔  Initialization complete
✔  Host preflights passed
✔  Node is ready
✔  Storage is ready
✔  Runtime Operator is ready
✔  Admin Console is ready
✔  Additional components are ready

-----------------------------------------------------------------
Visit the Admin Console to configure and install slackernews-gnu:

http://10.0.0.11:30000
-----------------------------------------------------------------
```

--------------------------------

### Run standard installer

Source: https://docs.replicated.com/vendor/enterprise-portal-configure.md

Executes the standard installer with a license file.

```bash
sudo ./${app.slug} install --license license.yaml
```

--------------------------------

### GET /license/fields - Response

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Example JSON response from the /license/fields endpoint.

```json
{
  "expires_at": {
    "name": "expires_at",
    "title": "Expiration",
    "description": "License Expiration",
    "value": "2023-05-30T00:00:00Z",
    "valueType": "String",
    "signature": {
      "v1": "Vs+W7+sF0RA6UrFEJcyHAbC5YCIT67hdsDdqtJTRBd4ZitTe4pr1D/SZg2k0NRIozrBP1mXuTgjQgeI8PyQJc/ctQwZDikIEKFW0sVv0PFPQV7Uf9fy7wRgadfUxkagcCS8O6Tpcm4WqlhEcgiJGvPBki3hZLnMO9Ol9yOepZ7UtrUMVsBUKwcTJWCytpFpvvOLfSNoHxMnPuSgpXumbHZjvdXrJoJagoRDXPiXXKGh02DOr58ncLofYqPzze+iXWbE8tqdFBZc72lLayT1am3MN0n3ejCNWNeX9+CiBJkqMqLLkjN4eugUmU/gBiDtJgFUB2gq8ejVVcohqos69WA=="
    }
  },
  "numSeats": {
    "name": "numSeats",
    "title": "Number of Seats",
    "value": 10,
    "valueType": "Integer",
    "signature": {
      "v1": "UmsYlVr4+Vg5TWsJV6goagWUM4imdj8EUUcdau7wIzfcU0MuZnv3UNVlwVE/tCuROCMcbei6ygjm4j5quBdkAGUyq86BCtohg/SqRsgVoNV6BN0S+tnqJ7w4/nqRVBc2Gsn7wTYNXiszLMkmfeNOrigLgsrtaGJmZ4IsczwI1V5Tr+AMAgrACL/UyLg78Y6EitKFW4qvJ9g5Q8B3uVmT+h9xTBxJFuKTQS6qFcDx9XCu+bKqoSmJDZ8lwgwpJDAiBzIhxiAd66lypHX9cpOg5A7cKEW+FLdaBKQdNRcPHQK2O9QwFj/NKEeCJEufuD3OeV8MSbN2PCehMzbj7tXSww=="
    }
  }
}
```

--------------------------------

### GET /license/info - Response

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Example JSON response from the /license/info endpoint.

```json
{
  "licenseID": "YiIXRTjiB7R...",
  "appSlug": "my-app",
  "channelID": "2CBDxNwDH1xyYiIXRTjiB7REjKX",
  "channelName": "Stable",
  "customerName": "Example Customer",
  "customerEmail": "username@example.com",
  "licenseType": "dev",
  "licenseSequence": 1,
  "isAirgapSupported": false,
  "isGitOpsSupported": false,
  "isIdentityServiceSupported": false,
  "isGeoaxisSupported": false,
  "isSnapshotSupported": false,
  "isSupportBundleUploadSupported": false,
  "isSemverRequired": true,
  "endpoint": "https://replicated.app",
  "entitlements": {
    "expires_at": {
      "title": "Expiration",
      "description": "License Expiration",
      "value": "",
      "valueType": "String"
    },
    "numSeats": {
      "title": "Number of Seats",
      "value": 10,
      "valueType": "Integer"
    }
  }
}
```

--------------------------------

### Install preflight and support-bundle plugins with Krew

Source: https://docs.replicated.com/vendor/environment-setup.md

Use Krew to install the preflight and support-bundle plugins on Windows or Linux.

```bash
kubectl krew install preflight
kubectl krew install support-bundle
```

--------------------------------

### GET /app/history

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Lists details about the releases that an application instance has installed previously.

```APIDOC
## GET /app/history

### Description
List details about the releases that an application instance has installed previously.

### Method
GET

### Endpoint
http://replicated:3000/api/v1/app/history

### Response
#### Success Response (200)
- **releases** (array) - A list of previously installed releases.
  - **versionLabel** (string) - The version label of the release.
  - **channelID** (string) - The ID of the channel.
  - **channelName** (string) - The name of the channel.
  - **createdAt** (string) - The timestamp when the release was created.
  - **releaseNotes** (string) - The release notes.
  - **helmReleaseName** (string) - The name of the Helm release.
  - **helmReleaseRevision** (integer) - The revision of the Helm release.
  - **helmReleaseNamespace** (string) - The namespace of the Helm release.

#### Response Example
{
  "releases": [
    {
      "versionLabel": "0.1.70",
      "channelID": "2CBDxNwDH1xyYiIXRTjiB7REjKX",
      "channelName": "Stable",
      "createdAt": "2023-05-12T17:43:51Z",
      "releaseNotes": "",
      "helmReleaseName": "echo-server",
      "helmReleaseRevision": 2,
      "helmReleaseNamespace": "echo-server-helm"
    }
  ]
}
```

--------------------------------

### Prepare Manifests Directory

Source: https://docs.replicated.com/vendor/quick-start.md

Create a manifests directory and move the packaged chart into it.

```bash
cd ../..
```

```bash
mkdir manifests
```

```bash
mv chart/slackernews/slackernews-1.0.0.tgz manifests
```

--------------------------------

### GET /license/fields/{field_name} - Response

Source: https://docs.replicated.com/reference/replicated-sdk-apis.md

Example JSON response from the /license/fields/{field_name} endpoint.

```json
{
  "name": "expires_at",
  "title": "Expiration",
  "description": "License Expiration",
  "value": "2023-05-30T00:00:00Z",
  "valueType": "String",
  "signature": {
    "v1": "c6rsImpilJhW0eK+Kk37jeRQvBpvWgJeXK2MD0YBlIAZEs1zXpmvwLdfcoTsZMOj0lZbxkPN5dPhEPIVcQgrzfzwU5HIwQbwc2jwDrLBQS4hGOKdxOWXnBUNbztsHXMqlAYQsmAhspRLDhBiEoYpFV/8oaaAuNBrmRu/IVAW6ahB4KtP/ytruVdBup3gn1U/uPAl5lhzuBifaW+NDFfJxAXJrhdTxMBxzfdKa6dGmlGu7Ou/xqDU1bNF3AuWoP3C78GzSBQrD1ZPnu/d+nuEjtakKSX3EK6VUisNucm8/TFlEVKUuX7hex7uZ9Of+UgS1GutQXOhXzfMZ7u+0zHXvQ=="
  }
}
```
Tokens:
Raw