Skip to content

Commit

Permalink
Merge pull request #79 from zackbradys/main
Browse files Browse the repository at this point in the history
Updated Instructions for STIGATRON
  • Loading branch information
amartin120 authored Sep 26, 2023
2 parents f7b512e + a0b9066 commit 1861480
Show file tree
Hide file tree
Showing 4 changed files with 280 additions and 410 deletions.
24 changes: 8 additions & 16 deletions docs/stigatron-docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ On the `local` cluster running Rancher MCM, you'll need to first enable Extensio
1. Log into the Rancher MCM as an administrator.
2. Click the menu in the upper-left of the main dashboard and click the `Extensions` link near the bottom.
3. Click the `Enable` button on the Extensions screen.
4. Click `Ok`, when prompted to Enable Extension Support.

![Enable Extensions](/img/stigatron/enable-extensions.png)

### Installing STIGATRON UI Plugin

Next, on the same `local` cluster, run the following Helm commands to install the UI Plugin for STIGATRON (see the `tgz` method above for airgap with no Helm repository), substituting your registry in:
Next, on the same `local` cluster, run the following Helm commands to install the UI Plugin for STIGATRON (see the `tgz` method above for airgap with no Helm repository) and ensure to substitute your registry:

```bash
helm install -n carbide-stigatron-system --create-namespace \
Expand All @@ -36,28 +37,20 @@ On downstream RKE2 clusters, you'll need to first install Rancher's CIS Benchmar
1. Navigate to your cluster in the `Explore Cluster` menu.
2. On the left, select `Apps` and click `Charts`.
3. In the `Filter` box on the right, type `CIS Benchmark`.
4. Leave the default values and continue selecting `Next`, then click `Install`.
5. Wait for the installation to complete.
4. Review the `Chart Information` and when ready click `Install`.
5. Leave all default values, select `Next`, and then click `Install`.
6. Wait for the installation to complete and feel free to close the kubectl shell.

### Creating the License Secret

Next, you'll need to create the `carbide-stigatron-system` namespace and create a secret named `stigatron-license` containing your license (this step is **critical**, as STIGATRON operator will not start without this secret present):
Next, you'll need to create the `carbide-stigatron-system` namespace and create a secret named `stigatron-license` containing your Carbide License. *This step is **critical**, as STIGATRON operator will not start without this secret present:*

```bash
# Create the namespace
kubectl create namespace carbide-stigatron-system

# Now create the secret, substituting your license
kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
name: stigatron-license
namespace: carbide-stigatron-system
type: Opaque
stringData:
license: YOUR_LICENSE_HERE
EOF
kubectl create secret generic stigatron-license -n carbide-stigatron-system --from-literal=license=YOUR_LICENSE_HERE
```

### Installing STIGATRON Operator
Expand All @@ -77,5 +70,4 @@ Check the status of the rollout:
helm status -n carbide-stigatron-system stigatron
```

You should now see `STIGATRON` on the left menu of your Explore Cluster.

You should now see `STIGATRON` on the left menu of your Explore Cluster.
10 changes: 5 additions & 5 deletions docs/stigatron-docs/prereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

In order to install STIGATRON, you need the following:

* For pulling/storing the STIGATRON images in your registry, you'll need the [Cosign CLI](https://github.com/sigstore/cosign).
* For installation, you'll need the [Helm CLI](https://helm.sh/docs/intro/install/).
* Access to the `local` cluster that the Rancher Multi-cluster Manager is running on, and the ability to install Helm charts on it.
* Since STIGATRON utilizes Rancher's UI Extensions capability, you need to be running Rancher v2.7.0+.
* Access to the downstream RKE2 cluster(s) you want to install STIGATRON onto.
* **[Cosign CLI](https://github.com/sigstore/cosign):** For pulling and loading images in your registry.
* **[Helm CLI](https://helm.sh/docs/intro/install/):** For installation of the required Helm charts.
* **[Rancher v2.7.0+](https://ranchermanager.docs.rancher.com/integrations-in-rancher/rancher-extensions):** STIGATRON utilizes Rancher's UI Extensions Capability.
* Access to the `local` RKE2 cluster for the Rancher Multi-cluster Manager and the access to install Helm charts.
* Access to the `downstream` RKE2 cluster(s) that you would like to install and scan with STIGATRON.
144 changes: 72 additions & 72 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1861480

Please sign in to comment.