Add new topic on setting up your environment for replicated #3351
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| @@ -21,11 +21,9 @@ The following are some best practices and recommendations for successfully onboa | |||
|
|
|||
| * 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. | |||
|
|
|||
| * 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). | |||
There was a problem hiding this comment.
^ removed this xref because I added a new link to the "Set Up Your Environment" page in the prerequisites
| * 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). | ||
|
|
||
| * 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. | ||
| * 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). |
There was a problem hiding this comment.
^ link to the new Set Up Your Environment topic in the prerequisites for onboarding
| @@ -436,7 +434,9 @@ To support and test Helm installations: | |||
|
|
|||
| 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). | |||
|
|
|||
| 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). | |||
| 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_. | |||
There was a problem hiding this comment.
^ This is the Add Support for Helm Installations subsection. Previously, we didn't explicitly tell people that they needed a cluster for testing
| import Logout from "../partials/replicated-cli/_logout.mdx" | ||
| import AuthToken from "../partials/replicated-cli/_authorize-with-token-note.mdx" | ||
|
|
||
| # Set Up Your Environment |
There was a problem hiding this comment.
New topic with information from https://community.replicated.com/t/setting-up-your-system-for-working-with-the-replicated-platform/1528 about how to set up you local workstation, and about creating VMs/clusters for testing releases.
I used partials to share some preexisting content between pages. For example, the steps on installing the Replicated CLI are shared between this topic and https://docs.replicated.com/reference/replicated-cli-installing
|
|
||
| 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. | ||
|
|
||
| ## Set Up Your Local Workstation {#local} |
There was a problem hiding this comment.
Split this up in two main sections:
- Set up local workstation
- Set up dev environments for testing
I wanted to explicitly make this distinction because I think there's some confusion with new onboarders around what gets installed locally versus in a dev/"sample customer" environment
|
|
||
| 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. | ||
|
|
||
| For information about how to create a cluster with Compatibility Matrix, see [Prerequisites](/vendor/testing-how-to#prerequisites) and [Create Clusters](/vendor/testing-how-to#create-clusters) in _Use Compatibility Matrix_. |
There was a problem hiding this comment.
will be nice in the future when you can create VMs and air gap environments with CMX to include those here too
| @@ -38,6 +38,7 @@ const sidebars = { | |||
| 'intro-replicated', | |||
| 'vendor/kots-faq', | |||
| 'vendor/quick-start', | |||
| 'vendor/environment-setup', | |||
There was a problem hiding this comment.
added to Get Started section of sidebar
| sudo mv linux-amd64/helm /usr/local/bin/helm | ||
| ``` | ||
|
|
||
| ### Install and Authorize the Replicated CLI |
There was a problem hiding this comment.
Most of this was existing content from the Install the Replicated CLI topic. I like that it already included the info about how to authorize the cli with the login command or with env vars
I also updated this to include your WSL2 recommendation for windows
https://deploy-preview-3351--replicated-docs.netlify.app/vendor/environment-setup