Skip to content

Enterprise portal docs (draft) #3218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Enterprise portal docs (draft) #3218

wants to merge 17 commits into from

Conversation

paigecalvert
Copy link
Contributor

No description provided.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Apr 30, 2025
Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 191176e
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/682bcb2230ac4f0008a15377
😎 Deploy Preview https://deploy-preview-3218--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 191176e
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/682bcb2296862f00080bfb04
😎 Deploy Preview https://deploy-preview-3218--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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


The **Install Attempts** section includes the following details about each installation attempt:
* The installation status (succeeded, stalled, or failed)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ what are the possible statuses for install attempts?

* **OS** or **K8s**: The operating system of the VM or bare metal server. Or, the distribution of Kubernetes running in the installation environment.
* **Mode**: If the installation is online (internet-connected) or air gap (offline).
* **Registry**: If the image registry used is online (accessed over the internet) or offline (a local registry is used). For air gap installations, the registry is always offline. Users can also optionally use a local image registry in online installations.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ this was a guess of what online/offline meant for the Registry field. I figure it has to do with if they have a local registry configured?

* For installations with Replicated Embedded Cluster on VMs or bare metal servers, the Enterprise Portal reports when the installation assets were downloaded, as shown below:
![VM-based install attempt progress details](/images/customer-reporting-install-attempts-vm.png)
[View a larger version of this image](/images/customer-reporting-install-attempts-vm.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I wasn't sure about the different install characteristics that determine which progress indicators are included

for example, I saw "registry login" and "images pulled" show up on certain installs, and it looked like those were all helm installs, but could use confirmation

same with "assets downloaded". those are just for EC, I guess?

</tr>
<tr>
<td>Page overview</td>
<td>An overview of the Enterprise Portal.</td>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I don't think I saw where this appears in the Enterprise Portal

</tr>
<tr>
<td>Instance labels</td>
<td>Any labels applied to the instance.</td>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I'm not sure about this one. I saw something that appeared to be labels in the UI, but wasn't sure where those would be set

</tr>
<tr>
<td>Instance ID</td>
<td>The unique identifier for the instance.</td>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ does this always show an id or can users set a nickname?

</tr>
<tr>
<td>Version</td>
<td>The application version installed.</td>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ I figure this is just the application/release version that's installed? wasn't sure if there would be any reason this wouldn't match the exact version that's in the vendor portal

@paigecalvert paigecalvert marked this pull request as ready for review May 20, 2025 00:24
@paigecalvert paigecalvert requested a review from a team as a code owner May 20, 2025 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants