Skip to content

Commit 9cdaf5a

Browse files
committed
Add new topic on setting up your environment for replicated
1 parent d89822e commit 9cdaf5a

File tree

3 files changed

+136
-17
lines changed

3 files changed

+136
-17
lines changed

docs/vendor/environment-setup.mdx

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
import Requirements from "../partials/embedded-cluster/_requirements.mdx"
2+
3+
# Set Up Your Environment
4+
5+
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:
22+
23+
```
24+
# macOS
25+
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl"
26+
chmod +x ./kubectl
27+
sudo mv ./kubectl /usr/local/bin/kubectl
28+
```
29+
30+
#### Linux
31+
32+
Linux users have similar options, whether through package managers or direct downloads:
33+
34+
```
35+
# Using curl
36+
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
37+
chmod +x ./kubectl
38+
sudo mv ./kubectl /usr/local/bin/kubectl
39+
40+
# Or using package manager (Ubuntu/Debian)
41+
sudo apt-get update
42+
sudo apt-get install -y kubectl
43+
44+
# Or using package manager (CentOS/RHEL/Fedora)
45+
sudo yum install -y kubectl
46+
```
47+
48+
### Install Helm
49+
50+
Install the Helm CLI.
51+
52+
#### Mac
53+
54+
Homebrew:
55+
56+
```
57+
brew install helm
58+
```
59+
60+
Or the official installation script that works across platforms:
61+
```
62+
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
63+
```
64+
#### Linux
65+
For manual installation on Linux:
66+
```
67+
curl -LO https://get.helm.sh/helm-v3.12.0-linux-amd64.tar.gz
68+
tar -zxvf helm-v3.12.0-linux-amd64.tar.gz
69+
sudo mv linux-amd64/helm /usr/local/bin/helm
70+
```
71+
72+
### Install the Replicated CLI
73+
74+
The Replicated CLI serves as your primary interface to the platform.
75+
76+
#### Mac
77+
On macOS, it’s available through a dedicated Homebrew tap:
78+
```
79+
brew install replicatedhq/replicated/cli
80+
```
81+
#### Linux
82+
Linux users can grab the latest release directly from GitHub:
83+
```
84+
curl -s https://api.github.com/repos/replicatedhq/replicated/releases/latest \
85+
| grep "browser_download_url.*linux_amd64.tar.gz" \
86+
| cut -d : -f 2,3 \
87+
| tr -d \" \
88+
| wget -O replicated.tar.gz -qi -
89+
90+
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.

docs/vendor/replicated-onboarding.mdx

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ The following are some best practices and recommendations for successfully onboa
2121

2222
* 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.
2323

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

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

3028
### Getting Help from the Community {#community}
3129

@@ -35,23 +33,19 @@ Before posting in the community site, use the search to find existing knowledge
3533

3634
To search and participate in the Replicated community, see https://community.replicated.com/.
3735

38-
### Prerequisites
36+
## Prerequisites
3937

4038
* 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).
4139

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).
4741

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

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+
:::
5147

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).
5549

5650
## Onboard
5751

@@ -416,7 +410,7 @@ After completing the main onboarding tasks, Replicated recommends that you also
416410

417411
### Add Support for Helm Installations
418412

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

421415
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.
422416

@@ -436,7 +430,9 @@ To support and test Helm installations:
436430

437431
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).
438432

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).
440436

441437
### Add Support for Air Gap Installations
442438

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ const sidebars = {
3838
'intro-replicated',
3939
'vendor/kots-faq',
4040
'vendor/quick-start',
41+
'vendor/environment-setup',
4142
'vendor/replicated-onboarding',
4243
// {
4344
// type: 'category',

0 commit comments

Comments
 (0)