Skip to content

Commit 9da58f1

Browse files
committed
overview reorg
1 parent c3326f6 commit 9da58f1

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/vendor/embedded-overview.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,22 @@ To install with Embedded Cluster, you can follow the customer-specific instructi
132132

133133
[View a larger version of this image](/images/embedded-cluster-install-dialog.png)
134134

135+
### (Optional) Serve Installation Assets Using the Vendor API
136+
137+
To install with Embedded Cluster, you need to download the Embedded Cluster installer binary and a license. Air gap installations also require an air gap bundle. Some vendors already have a portal where their customers can log in to access documentation or download artifacts. In cases like this, you can serve the Embedded Cluster installation essets yourself using the Replicated Vendor API, rather than having customers download the assets from the Replicated app service using a curl command during installation.
138+
139+
To serve Embedded Cluster installation assets with the Vendor API:
140+
141+
1. If you have not done so already, create an API token for the Vendor API. See [Using the Vendor API v3](/reference/vendor-api-using#api-token-requirement).
142+
143+
1. Call the [Get an Embedded Cluster release](https://replicated-vendor-api.readme.io/reference/getembeddedclusterrelease) endpoint to download the assets needed to install your application with Embedded Cluster. Your customers must take this binary and their license and copy them to the machine where they will install your application.
144+
145+
Note the following:
146+
147+
* (Recommended) Provide the `customerId` query parameter so that the customer’s license is included in the downloaded tarball. This mirrors what is returned when a customer downloads the binary directly using the Replicated app service and is the most useful option. Excluding the `customerId` is useful if you plan to distribute the license separately.
148+
149+
* If you do not provide any query parameters, this endpoint downloads the Embedded Cluster binary for the latest release on the specified channel. You can provide the `channelSequence` query parameter to download the binary for a particular release.
150+
135151
### About Host Preflight Checks
136152

137153
During installation, Embedded Cluster automatically runs a default set of _host preflight checks_. The default host preflight checks are designed to verify that the installation environment meets the requirements for Embedded Cluster, such as:
@@ -186,22 +202,6 @@ Multi-node clusters are not highly available by default. After three controller
186202

187203
For more information about creating HA multi-node clusters with Embedded Cluster, see [Enable High Availability for Multi-Node Clusters (Alpha)](/enterprise/embedded-manage-nodes#ha) in _Adding and Managing Nodes with Embedded Cluster_.
188204

189-
## (Optional) Serve Installation Assets Using the Vendor API
190-
191-
To install with Embedded Cluster, you need to download the Embedded Cluster installer binary and a license. Air gap installations also require an air gap bundle. Some vendors already have a portal where their customers can log in to access documentation or download artifacts. In cases like this, you can serve the Embedded Cluster installation essets yourself using the Replicated Vendor API, rather than having customers download the assets from the Replicated app service using a curl command during installation.
192-
193-
To serve Embedded Cluster installation assets with the Vendor API:
194-
195-
1. If you have not done so already, create an API token for the Vendor API. See [Using the Vendor API v3](/reference/vendor-api-using#api-token-requirement).
196-
197-
1. Call the [Get an Embedded Cluster release](https://replicated-vendor-api.readme.io/reference/getembeddedclusterrelease) endpoint to download the assets needed to install your application with Embedded Cluster. Your customers must take this binary and their license and copy them to the machine where they will install your application.
198-
199-
Note the following:
200-
201-
* (Recommended) Provide the `customerId` query parameter so that the customer’s license is included in the downloaded tarball. This mirrors what is returned when a customer downloads the binary directly using the Replicated app service and is the most useful option. Excluding the `customerId` is useful if you plan to distribute the license separately.
202-
203-
* If you do not provide any query parameters, this endpoint downloads the Embedded Cluster binary for the latest release on the specified channel. You can provide the `channelSequence` query parameter to download the binary for a particular release.
204-
205205
## About Performing Updates with Embedded Cluster
206206

207207
<UpdateOverview/>

0 commit comments

Comments
 (0)