reduce redundancy with stigatron and airgapped docs install instructions

rancherfederal · Jun 24, 2024 · 41ec60d · 41ec60d
1 parent f95abf1
commit 41ec60d
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 61 deletions.
diff --git a/docs/airgapped-docs/prereqs.md b/docs/airgapped-docs/prereqs.md
@@ -3,29 +3,15 @@
 In order to utilize Airgapped Docs, you will need the following prerequisites:
 
 - **Rancher v2.7.0 or higher:** https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions
-- **Hauler:** https://github.com/rancherfederal/hauler
 - **Helm:** https://helm.sh/docs/intro/install
 - Access to the `local` cluster, to be able to install and deploy the app(s).
 - Access to the `downstream` cluster(s), to be able to install and deploy the app(s).
 
-# Getting Started
+It is also assumed you have followed all of the Carbide Secured Registry (CSR) documentation.
 
-This will guide you through getting started with Airgapped Docs.
-
-## Airgapped Docs Images
-
-The images for Airgapped Docs can be found [here](https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images). You'll need to pull these images using `hauler`.
-
-### Internet-Connected Environment
-
-If you're working in a connected environment, look [here](../registry-docs/copying-images.md) for instructions on pulling the images into your registry.
-
-### Airgapped Environment
-
-If you're working in an airgapped environment, look [here](../registry-docs/downloading-images.md) for instructions on pulling the images locally.
-
-On the airgap, look [here](../registry-docs/loading-images.md) for loading the localized images into the airgapped registry.
-
-## Airgapped Docs Helm Chart
-
-The chart for Airgapped Docs can be found [here](../carbide-charts.md). You'll need to pull the chart using `hauler`.
+This means you have:
+- seeded your registry with the images from the CSR
+- the carbide helm charts available for use
+- configured k3s/rke2 to use your registry
+- configured Rancher Manager to use your registry
+- setup policy enforcement to only allow images from the CSR to run
diff --git a/...stry-docs/configuration/carbide-charts.md → docs/registry-docs/carbide-charts.md b/...stry-docs/configuration/carbide-charts.md → docs/registry-docs/carbide-charts.md
@@ -1,7 +1,8 @@
 # Carbide Helm Charts
 
-### Available Helm Charts
+Along with the our secured images provided through the CSR, we also provide helm charts to install various components of the carbide product suite. These include charts include the necessary components to run STIGATRON, an airgapped copy of all rancher product docs, as well as custom build of rancher with our white-labeling.
 
+**Available Helm Charts**
 ```bash
 NAME                            CHART VERSION   APP VERSION     DESCRIPTION
 carbide-charts/airgapped-docs   0.1.49          0.1.4           Rancher Government Airgapped Docs
@@ -11,10 +12,11 @@ carbide-charts/stigatron        0.2.5           0.2.2           Rancher Governme
 carbide-charts/stigatron-ui     0.2.3           0.2.0           Rancher Government Stigatron UI Extension
 ```
 
-## How To Use (Connected Environments)
+The charts are available at https://rancherfederal.github.io/carbide-charts.
 
-### For Helm Chart Repositories
+## Obtaining Chart Manifests
 
+### Connected Environments
 ```bash
 # add and update the helm chart repository
 helm repo add carbide-charts https://rancherfederal.github.io/carbide-charts
@@ -27,14 +29,11 @@ helm search repo carbide-charts
 helm install <release-name> carbide-charts/<chart>
 ```
 
-If you would like to do add the Carbide Helm Charts to the Rancher Manager Chart Catalog, so you are able to use the user interface to install them, please follow the steps in the [Rancher Manager Docs](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher).
+If you would like to add the Carbide Helm Charts to the Rancher Manager Chart Catalog (so you can use the user interface to install them) please follow the steps in the [Rancher Manager Docs](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher).
 
-## How to Use (Airgaped Environments)
-
-### For Helm Chart Repositories
-
-#### On Connected Environment
+### Airgapped Environments
 
+#### In Connected Environment
 ```bash
 # generate the hauler manfiest for the carbide charts
 cat <<EOF > carbide-charts.yaml
@@ -79,8 +78,7 @@ hauler store sync --store carbide-store --files carbide-charts.yaml --platform <
 hauler store save --store carbide-store --filename carbide-charts.tar.zst
 ```
 
-#### On Airgapped Environment
-
+#### In Airgapped Environment
 ```bash
 # load the content from the tarball to the hauler store
 hauler store load --store carbide-store carbide-charts.tar.zst

diff --git a/docs/registry-docs/configuration/rancher.md b/docs/registry-docs/configuration/rancher.md
@@ -1,6 +1,6 @@
 # Rancher Manager Configuration
 
-This page will walk you through how to configure Rancher Manager to use images from the **CSR (Carbide Secured Registry)** instead of the upstream Docker Hub images. This will apply to both its own components and downstream Rancher Kubernetes clusters (RKE2/K3s).
+This page will walk you through how to configure Rancher Manager to use images from the CSR instead of the upstream Docker Hub images. This will apply to both its own components and downstream Rancher Kubernetes clusters (RKE2/K3s).
 
 **NOTE**: Due to current limitations of cloud providers, this project will not work for managing Cloud Provider clusters (AKS, EKS, GKE). If you're currently using Rancher to manage those workloads, do not use this project. We intend to improve this experience in the future.
 

diff --git a/docs/stigatron-docs/prereqs.md b/docs/stigatron-docs/prereqs.md
@@ -3,29 +3,15 @@
 In order to utilize STIGATRON, you will need the following prerequisites:
 
 - **Rancher v2.7.0 or higher:** https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions
-- **Hauler:** https://github.com/rancherfederal/hauler
 - **Helm:** https://helm.sh/docs/intro/install
 - Access to the `local` cluster, to be able to install and deploy the app(s).
 - Access to the `downstream` cluster(s), to be able to install and deploy the app(s).
 
-# Getting Started
+It is also assumed you have followed all of the Carbide Secured Registry (CSR) documentation.
 
-This will guide you through getting started with STIGATRON.
-
-## STIGATRON Images
-
-The images for STIGATRON can be found [here](https://github.com/rancherfederal/carbide-releases/releases). You'll need to pull these images using `hauler`.
-
-### Internet-Connected Environment
-
-If you're working in a connected environment, look [here](../registry-docs/copying-images.md) for instructions on pulling the images into your registry.
-
-### Airgapped Environment
-
-If you're working in an airgapped environment, look [here](../registry-docs/downloading-images.md) for instructions on pulling the images locally.
-
-On the airgap, look [here](../registry-docs/loading-images.md) for loading the localized images into the airgapped registry.
-
-## STIGATRON Helm Chart
-
-The chart for STIGATRON can be found [here](../carbide-charts.md). You'll need to pull the chart using `hauler`.
+This means you have:
+- seeded your registry with the images from the CSR
+- the carbide helm charts available for use
+- configured k3s/rke2 to use your registry
+- configured Rancher Manager to use your registry
+- setup policy enforcement to only allow images from the CSR to run
diff --git a/docs/stigatron-docs/uninstall.md b/docs/stigatron-docs/uninstall.md
@@ -5,7 +5,7 @@
 On the `local` cluster running Rancher MCM, run the following Helm command to remove the UI Extension.
 
 ```bash
-helm uninstall -n carbide-stigatron-system stigatron-ui carbide-charts/stigatron-ui
+helm uninstall -n carbide-stigatron-system stigatron-ui
 ```
 
 ## Downstream Clusters

diff --git a/sidebars.js b/sidebars.js
@@ -22,7 +22,7 @@ const sidebars = {
     'intro',
     {
       type: 'category',
-      label: 'Carbide Secured Registry',
+      label: 'Carbide Secured Registry (CSR)',
       collapsed: false,
       items: [
         'registry-docs/introduction',
@@ -57,17 +57,17 @@ const sidebars = {
             },
           ],
         },
+        {
+          type: 'doc',
+            id: 'registry-docs/carbide-charts',
+          label: 'Helm Charts',
+        },
         {
           type: 'category',
           label: 'Configuration',
           items: [
             'registry-docs/configuration/kubernetes',
             'registry-docs/configuration/rancher',
-            {
-              type: 'doc',
-                id: 'carbide-charts',
-              label: 'Helm Chart Configuration',
-            },
           ],
         },
         'registry-docs/enforcement',