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
This topic describes how to set up your environment to get started with the Replicated Platform. It includes information about installing the required tools on your local workstation as well as creating development environments for testing installation and upgrade scenarios for your application.
6
+
7
+
## Set Up Your Local Workstation {#local}
8
+
9
+
### Install kubectl
10
+
11
+
Install kubectl, the Kubernetes command line tool.
12
+
13
+
#### Mac
14
+
15
+
Homebrew
16
+
17
+
```
18
+
brew install kubectl
19
+
```
20
+
21
+
You can also fetch kubectl using curl from the official Kubernetes release endpoint:
tar xf replicated.tar.gz replicated && rm replicated.tar.gz
91
+
sudo mv replicated /usr/local/bin/
92
+
```
93
+
94
+
### Authorize the Replicated CLI with your Replicated Account
95
+
96
+
The `replicated login` command creates a token after you log in to your vendor account in a browser and saves it to a config file.
97
+
98
+
Authorize the Replicated CLI:
99
+
100
+
replicated login
101
+
102
+
In the browser window that opens, complete the prompts to log in to your vendor account and authorize the CLI.
103
+
104
+
Alteratively, if you do not have access to a browser, you can set the REPLICATED_API_TOKEN environment variable to authenticate. For more information, see (Optional) Set Environment Variables.
105
+
106
+
### Install the Preflight and Support Bundles CLIs
107
+
108
+
## Set Up Development Environments for Testing {#dev}
109
+
110
+
Testing your releases is an important part of the commercial software distribution lifecycle. Replicated recommends that you have access to a virtual machine (VM) and a cluster where you can deploy your releases for testing.
111
+
112
+
### Create a VM
113
+
114
+
Create a VM that you can use for testing installation with the Replicated Embedded Cluster installer. The VM must meet the following requirements:
115
+
116
+
<Requirements/>
117
+
118
+
### Create a Kubernetes Cluster
119
+
120
+
Create a Kubernetes Cluster for testing Helm installations.
121
+
122
+
You can use any cloud provider or tool that you prefer to create a cluster, such as [Replicated Compatibility Matrix](/vendor/testing-how-to), Google Kubernetes Engine (GKE), or minikube.
Copy file name to clipboardExpand all lines: docs/vendor/replicated-onboarding.mdx
+13-17Lines changed: 13 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,9 @@ The following are some best practices and recommendations for successfully onboa
21
21
22
22
* When integrating new Replicated features with an application, make changes in small iterations and test frequently by installing or upgrading the application in a development environment. This will help you to more easily identify issues and troubleshoot. This onboarding workflow will guide you through the process of integrating features in small iterations.
23
23
24
-
* Use the Replicated CLI to create and manage your application and releases. Getting familiar with the Replicated CLI will also help later on when integrating Replicated workflows into your CI/CD pipelines. For more information, see [Install the Replicated CLI](/reference/replicated-cli-installing).
24
+
* Use the Replicated CLI to create and manage your application and releases. Getting familiar with the Replicated CLI will also help later on when integrating Replicated workflows into your CI/CD pipelines.
25
25
26
-
* These onboarding tasks assume that you will test the installation of each release on a VM with the Replicated Embedded Cluster installer _and_ in a cluster with the Replicated KOTS installer. If you do not intend to offer existing cluster installations with KOTS (for example, if you intend to support only Embedded Cluster and Helm installations for your users), then can choose to test with Embedded Cluster only.
27
-
28
-
* Ask for help from the Replicated community. For more information, see [Get Help from the Community](#community) below.
26
+
* These onboarding tasks show you how to test the installation of each release on a VM with the Replicated Embedded Cluster installer _and_ in a cluster with the Replicated KOTS installer. If you do not intend to offer existing cluster installations with KOTS, then can choose to test with Embedded Cluster only.
29
27
30
28
### Getting Help from the Community {#community}
31
29
@@ -35,23 +33,19 @@ Before posting in the community site, use the search to find existing knowledge
35
33
36
34
To search and participate in the Replicated community, see https://community.replicated.com/.
37
35
38
-
###Prerequisites
36
+
## Prerequisites
39
37
40
38
* Create an account in the Vendor Portal. You can either create a new team or join an existing team. For more information, see [Create a Vendor Account](vendor-portal-creating-account).
41
39
42
-
* Install the Replicated CLI. See [Install the Replicated CLI](/reference/replicated-cli-installing).
43
-
44
-
* Complete a basic quick start workflow to create an application with a sample Helm chart and then promote and install releases in a development environment. This helps you get familiar with the process of creating, installing, and updating releases in the Replicated Platform. See [Replicated Quick Start](/vendor/quick-start).
45
-
46
-
* Ensure that you have access to a VM that meets the requirements for the Replicated Embedded Cluster installer. You will use this VM to test installation with Embedded Cluster.
40
+
* Set up your local workstation with the required toolkit for working with the Replicated Platform. See [Set Up Your Local Workstation](/vendor/environment-setup#local).
47
41
48
-
Embedded Cluster has the following requirements:
42
+
* Set up a VM. You will use this VM to test installation with the Replicated Embedded Cluster installer. See [Create a VM](/vendor/environment-setup#create-a-vm) in _Set Up Your Environment_.
49
43
50
-
<Requirements/>
44
+
:::note
45
+
You do not need access to a Kubernetes cluster for the main onboarding tasks, unless you intend to support existing cluster installations with Replicated KOTS. For information about how to create a cluster, see [Create a Kubernetes Cluster](/vendor/environment-setup#create-a-kubernetes-cluster) in _Set Up Your Environment_.
46
+
:::
51
47
52
-
* (Optional) Ensure that you have kubectl access to a Kubernetes cluster. You will use this cluster to test installation with KOTS. If you do not intend to offer existing cluster installations with KOTS (for example, if you intend to support only Embedded Cluster and Helm installations for your users), then you do not need access to a cluster for the main onboarding tasks.
53
-
54
-
You can use any cloud provider or tool that you prefer to create a cluster, such as [Replicated Compatibility Matrix](/vendor/testing-how-to), Google Kubernetes Engine (GKE), or minikube.
48
+
* Complete a basic quick start workflow to create an application with a sample Helm chart and then promote and install releases in a development environment. This helps you get familiar with the process of creating, installing, and updating releases in the Replicated Platform. See [Replicated Quick Start](/vendor/quick-start).
55
49
56
50
## Onboard
57
51
@@ -416,7 +410,7 @@ After completing the main onboarding tasks, Replicated recommends that you also
416
410
417
411
### Add Support for Helm Installations
418
412
419
-
Existing KOTS releases that include one or more Helm charts can be installed with the Helm CLI; it is not necessary to create and manage separate releases or channels for each installation method.
413
+
Existing releases that include one or more Helm charts can be installed with the Helm CLI; it is not necessary to create and manage separate releases or channels for each installation method.
420
414
421
415
To enable Helm installations for Helm charts distributed with Replicated, the only extra step is to add a Secret to your chart to authenticate with the Replicated proxy registry.
422
416
@@ -436,7 +430,9 @@ To support and test Helm installations:
436
430
437
431
1. Add the `.tgz` file to a release. For more information, see [Manage Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
438
432
439
-
1. Install the release in a cluster with the Helm CLI to test your changes. For more information, see [Install with Helm](/vendor/install-with-helm).
433
+
1. Create or get kubectl access to a cluster to test the installation. See [Create a Kubernetes Cluster](/vendor/environment-setup#create-a-kubernetes-cluster) in _Set Up Your Environment_.
434
+
435
+
1. In the cluster, istall the release with Helm to test your changes. For more information, see [Install with Helm](/vendor/install-with-helm).
0 commit comments