Skip to content

Commit 0b3b808

Browse files
committed
edits
1 parent a98ddb2 commit 0b3b808

File tree

2 files changed

+37
-22
lines changed

2 files changed

+37
-22
lines changed

docs/vendor/tutorial-embedded-cluster-automation.mdx

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
import DependencyYaml from "../partials/replicated-sdk/_dependency-yaml.mdx"
2+
import HelmPackage from "../partials/helm/_helm-package.mdx"
3+
import Requirements from "../partials/embedded-cluster/_requirements.mdx"
4+
15
# Perform a Headless Installation of SlackerNews
26

37
This topic provides a tutorial that demonstrates how to perform a headless installation for an application distributed with Replicated.
@@ -29,12 +33,12 @@ Before you begin, do the following to set up your environment:
2933
* Request Compatibility Matrix credits. You can request credits by creating a Vendor Portal account and then going to [**Compatibility Matrix > Request more credits**](https://vendor.replicated.com/compatibility-matrix) in the Vendor Portal. For more information about creating an account, see [Create a Vendor Account](vendor-portal-creating-account). For more information about Compatibility Matrix credits, see [Billing and Credits](/vendor/testing-about#billing-and-credits).
3034

3135
:::note
32-
If you are new to the Replicated platform, you might be eligible for $100 in free Compatibility Matrix credits. To request your free credits, reach out to our sales team at https://www.replicated.com/contact and note in the comments that you are completing the Replicated Quick Start.
36+
If you are new to the Replicated platform, you might be eligible for $100 in free Compatibility Matrix credits. To request your free credits, reach out to our sales team at https://www.replicated.com/contact and note in the comments that you are completing a Replicated tutorial.
3337
:::
3438

3539
* Ensure that you have an SSH key in your GitHub account. Then, add your GitHub username to your Vendor Portal [**Account Settings**](https://vendor.replicated.com/account-settings). This will provide SSH access to VMs that you create with Compatibility Matrix. For more information, see [Set Up SSH Access](/vendor/testing-vm-create#set-up-ssh-access) in _Create VMs_.
3640

37-
After you complete the prerequisites above, continue to the [Quick Start](#quick-start). You will create the VM with Compatibility Matrix as part of the tutorial.
41+
After you complete the prerequisites above, continue to the [Tutorial](#tutorial). You will create the VM with Compatibility Matrix as part of the tutorial.
3842

3943
* **Option 2: Bring your own VM.** Your VM must meet these requirements:
4044

@@ -70,39 +74,39 @@ Before you begin, do the following to set up your environment:
7074

7175
1. Authorize the Replicated CLI:
7276

73-
```bash
74-
replicated login
75-
```
76-
In the browser window that opens, follow the prompt to log in to your Vendor Portal account and authorize the CLI.
77+
```bash
78+
replicated login
79+
```
80+
In the browser window that opens, follow the prompt to log in to your Vendor Portal account and authorize the CLI.
7781

7882
1. Create an application named `SlackerNews`:
7983

80-
```bash
81-
replicated app create SlackerNews
82-
```
84+
```bash
85+
replicated app create SlackerNews
86+
```
8387

8488
1. Set the `REPLICATED_APP` environment variable to the application that you created:
8589

86-
```bash
87-
export REPLICATED_APP=APP_SLUG
88-
```
89-
Where `APP_SLUG` is the unique application slug provided in the output of the `app create` command.
90+
```bash
91+
export REPLICATED_APP=APP_SLUG
92+
```
93+
Where `APP_SLUG` is the unique application slug provided in the output of the `app create` command.
9094

91-
Setting the `REPLICATED_APP` environment variable allows you to interact with the application using the Replicated CLI without needing to use the `--app` flag with every command.
95+
Setting the `REPLICATED_APP` environment variable allows you to interact with the application using the Replicated CLI without needing to use the `--app` flag with every command.
9296

9397
1. Get the release files and Helm chart archive for SlackerNews:
9498

95-
1. Run the following command to download version 1.0.1 of the sample SlackerNews Helm chart to a new `quick-start` directory:
99+
1. Run the following command to download version 1.0.1 of the sample SlackerNews Helm chart to a new `tutorial-headless-install` directory:
96100

97-
```bash
98-
curl -O --create-dirs --output-dir quick-start https://docs.replicated.com/slackernews-1.0.1.tar.gz
99-
```
101+
```bash
102+
curl -O --create-dirs --output-dir tutorial-headless-install https://docs.replicated.com/slackernews-1.0.1.tar.gz
103+
```
100104

101105
1. Untar the chart:
102106

103-
```bash
104-
tar -xzf quick-start/slackernews-1.0.1.tar.gz -C quick-start/ && rm quick-start/slackernews-1.0.1.tar.gz
105-
```
107+
```bash
108+
tar -xzf tutorial-headless-install/slackernews-1.0.1.tar.gz -C tutorial-headless-install/ && rm tutorial-headless-install/slackernews-1.0.1.tar.gz
109+
```
106110

107111
1. Download and untar the release manifests:
108112

@@ -124,7 +128,7 @@ Before you begin, do the following to set up your environment:
124128
nonexistent-status-informer-object warn replicated-app.yaml 16 Status informer points to a nonexistent kubernetes object. If this is a Helm resource, this warning can be ignored.
125129
```
126130
:::note
127-
You can ignore `info` or `warn` messages for the purpose of this quick start.
131+
You can ignore `info` or `warn` messages for the purpose of this tutorial.
128132
:::
129133

130134
1. From the `manifests` directory, create a release and promote it to the Unstable channel:

docs/vendor/tutorial-helm-cli.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
import DependencyYaml from "../partials/replicated-sdk/_dependency-yaml.mdx"
2+
import HelmPackage from "../partials/helm/_helm-package.mdx"
3+
import Tabs from '@theme/Tabs';
4+
import TabItem from '@theme/TabItem';
5+
import HelmChartCr from "../partials/getting-started/_slackernews-chart.mdx"
6+
import KotsCr from "../partials/getting-started/_slackernews-repl-app.mdx"
7+
import K8sCr from "../partials/getting-started/_slackernews-k8s-app.mdx"
8+
import EcCr from "../partials/getting-started/_slackernews-embedded-cluster.mdx"
9+
import ConfigCr from "../partials/getting-started/_slackernews-config.mdx"
10+
import Requirements from "../partials/embedded-cluster/_requirements.mdx"
11+
112
# Install SlackerNews with the Helm CLI
213

314
This tutorial shows how to install a release using the Helm CLI.

0 commit comments

Comments
 (0)