Skip to content

Commit bbb7b10

Browse files
committed
edits
1 parent 7a44f69 commit bbb7b10

File tree

1 file changed

+50
-47
lines changed

1 file changed

+50
-47
lines changed

docs/vendor/environment-setup.mdx

Lines changed: 50 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,22 @@ This topic describes how to set up your environment to get started with the Repl
1414

1515
## Set Up Your Local Workstation {#local}
1616

17-
This section lists the tools that you need to install on your local workstation to manage applications, releases, customers, and so on with the Replicated Platform.
17+
This section lists the tools that you need to install on your local workstation to manage applications, releases, customers, and more with the Replicated Platform.
1818

1919
### Install kubectl
2020

21-
kubectl is the Kubernetes command line tool. With the Replicated Platform, you can use kubectl to communicate with the clusters that you create with the Replicated Compatibility Matrix. kubectl is also useful when testing and troubleshooting installations in existing clusters. For more information about kubectl, see [Command line tool (kubectl)](https://kubernetes.io/docs/reference/kubectl/) in the Kubernetes documentation.
21+
kubectl is the Kubernetes command line tool. You will use kubectl to communicate with the clusters that you create with the Replicated Compatibility Matrix, and when testing and troubleshooting installations in existing clusters. For more information about kubectl, see [Command line tool (kubectl)](https://kubernetes.io/docs/reference/kubectl/) in the Kubernetes documentation.
2222

2323
#### Mac
2424

2525
To install kubectl on Mac, do one of the following:
2626

27-
* (Recommended) Install with Homebrew:
27+
* Install with Homebrew:
2828
```bash
2929
brew install kubectl
3030
```
31-
* Install with curl:
31+
* Install using curl:
3232

33-
To install kubectl on Mac using curl:
3433
```bash
3534
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl"
3635
chmod +x ./kubectl
@@ -41,7 +40,7 @@ To install kubectl on Mac, do one of the following:
4140

4241
To install kubectl on Linux, do one of the following:
4342

44-
* Install with curl:
43+
* Install using curl:
4544

4645
```bash
4746
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
@@ -78,7 +77,7 @@ To install the Helm CLI on Mac, do one of the following:
7877
brew install helm
7978
```
8079

81-
* Or the official installation script that works across platforms:
80+
* Install using curl:
8281

8382
```bash
8483
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
@@ -150,11 +149,11 @@ To install the preflight and support-bundle plugins:
150149

151150
1. Install Krew:
152151

153-
* **Mac:**
152+
* Mac:
154153
```bash
155154
brew install krew
156155
```
157-
* **Other operating systems:**
156+
* Other operating systems:
158157
```bash
159158
(
160159
set -x; cd "$(mktemp -d)" &&
@@ -187,9 +186,9 @@ sbctl is a command-line tool that you can use to examine Kubernetes resources in
187186

188187
For more information, see the [sbctl](https://github.com/replicatedhq/sbctl) repository in GitHub.
189188

190-
To install sbctl:
189+
To install sbctl, run one of the following commands:
191190

192-
* **macOS Intel systems:**
191+
* macOS Intel systems:
193192

194193
```bash
195194
curl -LO https://github.com/replicatedhq/sbctl/releases/latest/download/sbctl_darwin_amd64.tar.gz
@@ -198,23 +197,23 @@ To install sbctl:
198197
sudo mv /tmp/sbctl /usr/local/bin/
199198
```
200199

201-
* **macOS Apple Silicon:**
200+
* macOS Apple Silicon:
202201
```bash
203202
curl -LO https://github.com/replicatedhq/sbctl/releases/latest/download/sbctl_darwin_arm64.tar.gz
204203
tar -xzf sbctl_darwin_arm64.tar.gz -C /tmp sbctl
205204
rm -f sbctl_darwin_arm64.tar.gz
206205
sudo mv /tmp/sbctl /usr/local/bin/
207206
```
208207

209-
* **Linux x86_64:**
208+
* Linux x86_64:
210209
```bash
211210
curl -LO https://github.com/replicatedhq/sbctl/releases/latest/download/sbctl_linux_amd64.tar.gz
212211
tar -xzf sbctl_linux_amd64.tar.gz -C /tmp sbctl
213212
rm -f sbctl_linux_amd64.tar.gz
214213
sudo mv /tmp/sbctl /usr/local/bin/
215214
```
216215

217-
* **Linux ARM64:**
216+
* Linux ARM64:
218217
```bash
219218
curl -LO https://github.com/replicatedhq/sbctl/releases/latest/download/sbctl_linux_arm64.tar.gz
220219
tar -xzf sbctl_linux_arm64.tar.gz -C /tmp sbctl
@@ -224,48 +223,52 @@ To install sbctl:
224223

225224
### (Recommended) Install Data Processing Tools
226225

227-
Replicated recommends that you install the following tools for parsing and manipulating JSON and YAML data when working with Kubernetes and Replicated configurations:
226+
Replicated recommends that you install the following tools for parsing and manipulating JSON and YAML data:
228227
* [jq](https://jqlang.org/) for JSON processing
229228
* [yq](https://mikefarah.gitbook.io/yq/) for YAML manipulation
230229

231-
These tools transform complex data manipulation tasks from multi-step processes into single commands, making your development workflow significantly more efficient.
232-
233-
* To install jq:
234-
235-
```bash
236-
# macOS
237-
brew install jq
230+
These tools are useful when working with Kubernetes and Replicated configurations to reduce complex data manipulation tasks from multi-step processes into single commands, simplifying your development workflow.
238231

239-
# Ubuntu/Debian
240-
sudo apt-get install jq
241-
242-
# CentOS/RHEL/Fedora
243-
sudo yum install jq
244-
245-
# Or download directly
246-
curl -LO https://github.com/stedolan/jq/releases/latest/download/jq-linux64
247-
chmod +x jq-linux64
248-
sudo mv jq-linux64 /usr/local/bin/jq
249-
```
232+
* To install jq, run one of the following commands:
250233

251-
* To install yq:
252-
253-
```bash
254-
# macOS
255-
brew install yq
256-
257-
# Linux
258-
curl -LO https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64
259-
chmod +x yq_linux_amd64
260-
sudo mv yq_linux_amd64 /usr/local/bin/yq
234+
* macOS:
235+
```bash
236+
brew install jq
237+
```
238+
* Ubuntu/Debian:
239+
```bash
240+
sudo apt-get install jq
241+
```
242+
* CentOS/RHEL/Fedora"
243+
```bash
244+
sudo yum install jq
245+
```
246+
* Direct download:
247+
```bash
248+
curl -LO https://github.com/stedolan/jq/releases/latest/download/jq-linux64
249+
chmod +x jq-linux64
250+
sudo mv jq-linux64 /usr/local/bin/jq
251+
```
261252

262-
# Or using go install
263-
go install github.com/mikefarah/yq/v4@latest
264-
```
253+
* To install yq, run one of the following commands:
254+
* macOS:
255+
```bash
256+
brew install yq
257+
```
258+
* Linux:
259+
```bash
260+
curl -LO https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64
261+
chmod +x yq_linux_amd64
262+
sudo mv yq_linux_amd64 /usr/local/bin/yq
263+
```
264+
* Go install:
265+
```bash
266+
go install github.com/mikefarah/yq/v4@latest
267+
```
265268

266269
## Set Up Development Environments for Testing {#dev}
267270

268-
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.
271+
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 install your application releases for testing.
269272

270273
### About Creating a VM
271274

0 commit comments

Comments
 (0)