Quick start updates #3439

paigecalvert · 2025-08-11T20:59:50Z

https://deploy-preview-3439--replicated-docs-upgrade.netlify.app/vendor/quick-start

netlify · 2025-08-11T20:59:58Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`28954d9`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs-upgrade/deploys/68a8aae6fe490600089e5f62
😎 Deploy Preview	https://deploy-preview-3439--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.

netlify · 2025-08-11T21:00:06Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`28954d9`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs/deploys/68a8aae6fe490600089e5f60
😎 Deploy Preview	https://deploy-preview-3439--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.

paigecalvert · 2025-08-21T00:07:16Z

docs/vendor/quick-start.mdx

+
+         1. In a browser, navigate to the URL for the DNS record with a target port of 30000.
+
+            The Admin Console opens.

   1. On the Admin Console landing page, click **Start**.


Note: For some reason, this page only appears for me when I use a non-CMX VM. Seems like when I use a CMX VM, I get jumped right to the log in screen (it also skips the security/cert pages). Curious if this happens for any of you when you go through the steps.

paigecalvert · 2025-08-21T00:08:46Z

docs/vendor/quick-start.mdx

+
+       This instance telemetry is automatically collected and sent back to the Vendor Portal by Embedded Cluster and the Replicated SDK. For more information, see [About Instance and Event Data](/vendor/instance-insights-event-data).
+
+    1. (Optional) Under **Instance ID**, click on the ID to view additional insights including the versions of Kubernetes and the Replicated SDK running in the cluster where you installed the application. 


^ Not really relevant to this quick start, but something that I thought was weird was that I included v1.7.2 of the SDK in my release, but it was showing up as v1.7.0 in the instance insights. Curious if the same thing happens for you all.

Ah never mind, probably this value in the slackernews chart: https://github.com/slackernews/slackernews/blob/main/chart/slackernews/values.yaml#L71

paigecalvert · 2025-08-21T00:09:50Z

docs/vendor/quick-start.mdx

+
+      :::note
+      If you see a `helm-archive-missing` error, confirm that you have only one chart archive in `manifests` for version 0.4.15, and that the `chartVersion` in the HelmChart resource is also set to `0.4.15`. If you notice that any of the errors are from files in your `.history/` directory, run `rm -rf .history` and then lint the files again.
+      :::


If you notice that any of the errors are from files in your .history/ directory, run rm -rf .history and then lint the files again.

These seems to happen to me a lot. Not sure if there's a better way to handle this (maybe customizing the linter to ignore .history?)

paigecalvert · 2025-08-21T00:10:52Z

docs/vendor/quick-start.mdx

+
+       * For **Hostname**:
+          * If you created the VM with Compatibility Matrix, enter the URL that you copied for the DNS record with a target port of 443. For example, `pensive-keldysh.ingress.replicatedcluster.com`.
+          * If you are using your own VM, provide the IP address where you are currently accessing the Admin Console. You can copy the IP address from your browser's address bar. Alternatively, if you have a hostname for your VM's IP address, you can provide that instead.


Alternatively, if you have a hostname for your VM's IP address, you can provide that instead.

Can remove this is we think it's not worth including. Wasn't really sure if everyone would have the same experience of being able to copy the ip address from the browser

paigecalvert · 2025-08-21T00:12:20Z

docs/vendor/quick-start.mdx

-   1. Run the following command to pull and untar version 1.0.6 of the Bitnami Gitea Helm chart:
+      ```
+      curl -O --create-dirs --output-dir quick-start https://docs.replicated.com/slackernews-0.4.14.tar.gz
+      ```


^ I hosted a tar.gz of the slackernews chart specifically for this tutorial so that I know that everyone is using the same files. This version makes the following edits:

uses public images that Chuck hosted on google artifact registry

Removes the sdk so that users can add it as part of the tutorial

Removes the preflights so that users can add them as part of the tutorial

paigecalvert · 2025-08-21T00:14:28Z

docs/partials/getting-started/_slackernews-config.mdx

@@ -0,0 +1,153 @@
+```yaml


Note: I left this config as is from Chuck's version (rather than removing a lot of the unused options). I wasn't too keen to try to back out all the interwoven values that pull from this in the chart. Plus, seems like a nice example of how you can use this config resource.

Instead, I tell people that they'll be ignoring most of these for the purpose of the tutorial.

paigecalvert · 2025-08-21T00:15:07Z

docs/vendor/quick-start.mdx

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


^ adds CMX option

docs/vendor/quick-start.mdx

crdant · 2025-08-21T15:16:41Z

Some notes that are as much about the Quick Start itself since a lot of my comments aren't on changes

Is there an appetite for linking to/incorporating Set Up Your Environment?
I don't think I care about the Helm chart version, but it's kind of arbitrary and not necessarily consistent with the production SlackerNews
Maybe we should change the data: URL to an https one to make Chart.yaml seem less intimidating
- Use the GitHub avatar?
- Actually, we have this one in replicated-app.yaml
EC version is updated and we should probably use it since the 1.31 version of k8 is almost out of support
Should be bring them to Enterprise Portal instead?
> In the Vendor Portal, on the page for the customer that you created, click Embedded Cluster install instructions.
Do we talk about "Admin Console" anywhere before this? If not, does it need to be described a bit?
> When prompted by the install command, set a password for accessing the Admin Console. You will use this password to log in to the Admin Console in a later step.
There's a wrinkle here if you its shows the private IP address, since you need to access it from the public one
> - If you brought your own VM, go to the URL provided in the output of the install command.
My browser switched to 443 automatically when I went to the amdin console, so I missed the steps around the certificate, maybe a note there?
I have broken icons, there was a fix I made to SlackerNews in the last couple of days to address that that should be in your image but may not be
Personal preference, but I like to use the long flag in tutorials and scripts when I'm not sure if someone will know the command, so helm package -u . would be helm package --dependency-update .

paigecalvert · 2025-08-21T16:22:59Z

@crdant thanks! comments below. main one that I could use your help on is the public versus private ip address thing for the vm

Some notes that are as much about the Quick Start itself since a lot of my comments aren't on changes

Is there an appetite for linking to/incorporating Set Up Your Environment?

For sure, I can add a link. I was a little light-handed on links in general for this quick start with the intention to help keep people on this page and limit "distractions"

I don't think I care about the Helm chart version, but it's kind of arbitrary and not necessarily consistent with the production SlackerNews

Very true. Might as well be 1.0.0 or something like that.

Maybe we should change the data: URL to an https one to make Chart.yaml seem less intimidating

Use the GitHub avatar?

Actually, we have this one in replicated-app.yaml

Good idea. That's an easy one.

EC version is updated and we should probably use it since the 1.31 version of k8 is almost out of support

Thanks 👍

Should be bring them to Enterprise Portal instead?

In the Vendor Portal, on the page for the customer that you created, click Embedded Cluster install instructions.

Covered in the other comment thread

Do we talk about "Admin Console" anywhere before this? If not, does it need to be described a bit?

When prompted by the install command, set a password for accessing the Admin Console. You will use this password to log in to the Admin Console in a later step.

We do talk about it in the step for configuring the manifests for the release. But it's not really explained well there either. I'll add something to the intro to call out this UI specifically

There's a wrinkle here if you its shows the private IP address, since you need to access it from the public one

If you brought your own VM, go to the URL provided in the output of the install command.

@crdant Ah okay. I didn't realize that--I always just go to link so I suppose I'm not sure then why that works. Is that something where we'd be able to tell them to make a change in their VM settings to allow them to access this? Or do you have a suggestion?

My browser switched to 443 automatically when I went to the amdin console, so I missed the steps around the certificate, maybe a note there?

I think this was another one that I added a comment on in the Files changed tab. This happens to me too when I use CMX, but not when I use a google cloud VM. Were you also using CMX?

I have broken icons, there was a fix I made to SlackerNews in the last couple of days to address that that should be in your image but may not be

I noticed that too...I did pull the latest down from your repo before repackaging the helm chart for this tutorial, but sounds like it might have been a change that's just in the securebuild image and not the public one that this points to?

Personal preference, but I like to use the long flag in tutorials and scripts when I'm not sure if someone will know the command, so helm package -u . would be helm package --dependency-update .

I'm down to change to the full flag

crdant · 2025-08-21T16:30:33Z

I have broken icons, there was a fix I made to SlackerNews in the last couple of days to address that that should be in your image but may not be

I noticed that too...I did pull the latest down from your repo before repackaging the helm chart for this tutorial, but sounds like it might have been a change that's just in the securebuild image and not the public one that this points to?

This is in the image. Let me make sure the public one matches the latest private one.

crdant · 2025-08-22T11:30:51Z

docs/vendor/quick-start.mdx

      ```

      At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.

-   1. Go to the URL provided in the output to access to the Admin Console.
+   1. Do one of the following to access the Admin Console:
+       * If you brought your own VM, go to the URL provided in the output of the install command.


We could do something like

:::note The IP address in the provided URL may be the private IP address of your virtual machine. You may need to edit the URL to use the public IP address. :::

paigecalvert added 6 commits August 8, 2025 16:54

update quick start with slackernews

e698efa

steps for getting smaple chart

5f4c0e3

edits

2c43af7

edits

d766666

edits

7bb605b

edits and update tar

5bbf003

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

paigecalvert added 20 commits August 11, 2025 15:06

rm slackernews archive to publish them in different pr

fcdacc9

edits

9b13b06

edits

0645577

edits

a0f35db

edits

f8ab6aa

adding screenshots

6caaae7

adding screenshots

8c72e01

adding screenshots

66f5650

adding screenshots

18f550e

edits

4d6125e

fix untar command

3a59d01

edits

a770e3c

update kots and k8s app yaml

26a0a9d

edit ingress and port info

091ba16

edit config page instructions

45fa69a

editing release yaml

ed3f90e

various edits

ffcaa36

edit related topics links

7a3ea51

edit prerequisites

3b1a116

edits

625ed6f

add screenshot and fix typos

cbb7b33

paigecalvert marked this pull request as ready for review August 21, 2025 00:05

paigecalvert requested a review from a team as a code owner August 21, 2025 00:05

paigecalvert commented Aug 21, 2025

View reviewed changes

docs/vendor/quick-start.mdx Show resolved Hide resolved

paigecalvert requested review from crdant and kayleemchugh August 21, 2025 00:33

crdant reviewed Aug 22, 2025

View reviewed changes

paigecalvert added 2 commits August 22, 2025 11:23

quick start edits

d70348f

edit

28954d9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Quick start updates #3439

Quick start updates #3439

Uh oh!

paigecalvert commented Aug 11, 2025 •

edited

Loading

Uh oh!

netlify bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

netlify bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

paigecalvert Aug 21, 2025 •

edited

Loading

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

paigecalvert Aug 21, 2025

Uh oh!

Uh oh!

crdant commented Aug 21, 2025

Uh oh!

paigecalvert commented Aug 21, 2025 •

edited

Loading

Uh oh!

crdant commented Aug 21, 2025

Uh oh!

crdant Aug 22, 2025 •

edited

Loading

Uh oh!

Uh oh!


		This instance telemetry is automatically collected and sent back to the Vendor Portal by Embedded Cluster and the Replicated SDK. For more information, see [About Instance and Event Data](/vendor/instance-insights-event-data).

		1. (Optional) Under Instance ID, click on the ID to view additional insights including the versions of Kubernetes and the Replicated SDK running in the cluster where you installed the application.

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

		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.

Quick start updates #3439

Are you sure you want to change the base?

Quick start updates #3439

Uh oh!

Conversation

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

Uh oh!

Uh oh!

netlify bot commented Aug 11, 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!

netlify bot commented Aug 11, 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!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

paigecalvert Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

crdant commented Aug 21, 2025

Uh oh!

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

Uh oh!

Uh oh!

crdant commented Aug 21, 2025

Uh oh!

crdant Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paigecalvert commented Aug 11, 2025 •

edited

Loading

netlify bot commented Aug 11, 2025 •

edited

Loading

netlify bot commented Aug 11, 2025 •

edited

Loading

paigecalvert Aug 21, 2025 •

edited

Loading

paigecalvert commented Aug 21, 2025 •

edited

Loading

crdant Aug 22, 2025 •

edited

Loading