Add new topic on setting up your environment for replicated #3351

paigecalvert · 2025-07-01T18:24:00Z

https://deploy-preview-3351--replicated-docs.netlify.app/vendor/environment-setup

netlify · 2025-07-01T18:24:05Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`fe9857c`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs/deploys/686d8386d179460008d4e57b
😎 Deploy Preview	https://deploy-preview-3351--replicated-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-07-01T18:24:31Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`fe9857c`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs-upgrade/deploys/686d838699543b0008668a8f
😎 Deploy Preview	https://deploy-preview-3351--replicated-docs-upgrade.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

docs/vendor/replicated-onboarding.mdx

paigecalvert · 2025-07-03T16:29:51Z

docs/vendor/replicated-onboarding.mdx

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


^ link to the new Set Up Your Environment topic in the prerequisites for onboarding

paigecalvert · 2025-07-03T16:37:28Z

docs/vendor/replicated-onboarding.mdx

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


^ This is the Add Support for Helm Installations subsection. Previously, we didn't explicitly tell people that they needed a cluster for testing

paigecalvert · 2025-07-03T16:39:15Z

docs/vendor/environment-setup.mdx

+import Logout from "../partials/replicated-cli/_logout.mdx"
+import AuthToken from "../partials/replicated-cli/_authorize-with-token-note.mdx"
+
+# Set Up Your Environment


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

paigecalvert · 2025-07-03T16:40:44Z

docs/vendor/environment-setup.mdx

+
+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}


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

paigecalvert · 2025-07-03T16:42:29Z

docs/vendor/environment-setup.mdx

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


will be nice in the future when you can create VMs and air gap environments with CMX to include those here too

Do we document some of the VM stuff now? If we do, why not refer to it.

We don't quite yet--talking with Han about getting this in in the next couple weeks though

Or I'll amend that to say that we do have the replicated vm commands doc'd, but that's more just because those cli docs are automatically generated

paigecalvert · 2025-07-03T16:42:47Z

sidebars.js

    'intro-replicated',
    'vendor/kots-faq',
    'vendor/quick-start',
+    'vendor/environment-setup',


added to Get Started section of sidebar

paigecalvert · 2025-07-03T16:46:01Z

docs/vendor/environment-setup.mdx

+sudo mv linux-amd64/helm /usr/local/bin/helm
+```
+
+###  Install and Authorize the Replicated CLI


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

crdant · 2025-07-08T16:30:42Z

docs/vendor/environment-setup.mdx

+
+### Install sbctl
+
+sbctl is a command-line tool that you can use to examine Kubernetes resources in support bundles. With sbctl, you can interact with the support bundle in a shell using kubectl commands to view and inspect resources.


"examine Kubernetes resources in support bundles" feels slightly off, though I'm not sure I have a better explanation…I usually explain it in the context of the support bundle having a snapshot of the state of the cluster, and sbctl letting you interact with that snapshot as if you had access to the cluster

Your explanation is clearer language and more direct, though I'm wondering if "Kubernetes resources in support bundles" doesn't imply something about the bundle that isn't accurate. There aren't actually any resources, right?

I usually explain it in the context of the support bundle having a snapshot of the state of the cluster, and sbctl letting you interact with that snapshot as if you had access to the cluster

I like that. I did struggle to explain this and agreed that I'm not sure "Kubernetes resources in support bundles" would necessarily make the most sense to people

crdant · 2025-07-08T16:31:02Z

docs/vendor/environment-setup.mdx

+* [jq](https://jqlang.org/) for JSON processing
+* [yq](https://mikefarah.gitbook.io/yq/) for YAML manipulation
+
+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.


love this wording

crdant · 2025-07-08T16:31:52Z

docs/vendor/environment-setup.mdx

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


Do we document some of the VM stuff now? If we do, why not refer to it.

docs/vendor/replicated-onboarding.mdx

crdant · 2025-07-08T16:37:32Z

docs/vendor/replicated-onboarding.mdx


-  Embedded Cluster has the following requirements:
+   :::note
+   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_.


don't you need to reference Helm here?

In this case "main onboarding tasks" refers to all the numbered tasks. Adding support for Helm is technically a "next step" after you onboard to Embedded Cluster.
I'm sure there's a more clear way for me to word that, though

Add new topic on setting up your environment for replicated

9cdaf5a

replicated-ci added type::docs Improvements or additions to documentation type::feature labels Jul 1, 2025

paigecalvert added 2 commits July 2, 2025 15:22

wip

61e5345

edits

4d75a82

paigecalvert marked this pull request as ready for review July 2, 2025 21:44

paigecalvert requested a review from a team as a code owner July 2, 2025 21:44

paigecalvert added 3 commits July 3, 2025 09:48

edits

5ae3c54

edits

7a44f69

edits

bbb7b10

paigecalvert commented Jul 3, 2025

View reviewed changes

docs/vendor/replicated-onboarding.mdx Show resolved Hide resolved

paigecalvert commented Jul 3, 2025

View reviewed changes

edits

26e17fb

paigecalvert commented Jul 3, 2025

View reviewed changes

paigecalvert requested a review from crdant July 7, 2025 17:07

crdant previously approved these changes Jul 8, 2025

View reviewed changes

edit the explanation of sbctl

86fed24

paigecalvert dismissed crdant’s stale review via 86fed24 July 8, 2025 20:32

edit prerequisites on setting up test environments

fe9857c

paigecalvert merged commit cbb8e6c into main Jul 8, 2025
5 checks passed

paigecalvert deleted the 125602 branch July 8, 2025 20:51


		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}


		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_. No newline at end of file


		### Install sbctl

		sbctl is a command-line tool that you can use to examine Kubernetes resources in support bundles. With sbctl, you can interact with the support bundle in a shell using kubectl commands to view and inspect resources.

Add new topic on setting up your environment for replicated #3351

Add new topic on setting up your environment for replicated #3351

Uh oh!

Conversation

paigecalvert commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs ready!

Uh oh!

netlify bot commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs-upgrade ready!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

paigecalvert commented Jul 1, 2025 •

edited

Loading

netlify bot commented Jul 1, 2025 •

edited

Loading

netlify bot commented Jul 1, 2025 •

edited

Loading