[ONPREM-2020] Update docs on Helm repo and shorten chart name (#20)

* Update docs for the Helm repo

* Shorten chart name

Author: christian-stephen

.circleci/config.yml

@@ -100,7 +100,7 @@ jobs:
             echo "${SIGNING_KEY_PASSPHRASE}" | ./do package-chart sign --passphrase-file -
       - run:
           name: List contents of Helm package
-          command: tar -tvf "./target/circleci-server-monitoring-stack-$(./do version).tgz"
+          command: tar -tvf "./target/server-monitoring-stack-$(./do version).tgz"
       - when:
           condition:
             equal: [<< pipeline.git.branch >>, main]
@@ -125,7 +125,7 @@ jobs:
           name: Publish Helm chart
           command: |
             package_cloud push circleci/server-monitoring-stack/helm/v1 \
-              ./target/circleci-server-monitoring-stack-"$(./do version)".tgz
+              ./target/server-monitoring-stack-"$(./do version)".tgz
       - run:
           name: "Push failed: Have you bumped the chart version?"
           command: |
@@ -161,17 +161,17 @@ jobs:
       - run:
           name: Create namespace
           command: |
-            kubectl create ns circleci-server-monitoring
-            kubectl config set-context --current --namespace circleci-server-monitoring
+            kubectl create ns server-monitoring
+            kubectl config set-context --current --namespace server-monitoring
       - run: ./do package-chart
       - run:
           name: Install dependencies
           command: |
-            helm install circleci-server-monitoring-stack ./target/circleci-server-monitoring-stack*.tgz \
-              -n circleci-server-monitoring --set global.enabled=false --set prometheusOperator.installCRDs=true
+            helm install server-monitoring-stack ./target/server-monitoring-stack*.tgz \
+              -n server-monitoring --set global.enabled=false --set prometheusOperator.installCRDs=true
       - run:
           name: Install Helm chart
-          command: helm upgrade --install circleci-server-monitoring-stack . --reset-values --timeout=2m -n circleci-server-monitoring
+          command: helm upgrade --install server-monitoring-stack . --reset-values --timeout=2m -n server-monitoring
       - run:
           name: Watch Pods
           command: kubectl get pods -w
@@ -213,7 +213,7 @@ jobs:
           when: on_fail
       - run:
           name: Uninstall Helm chart
-          command: helm uninstall circleci-server-monitoring-stack -n circleci-server-monitoring
+          command: helm uninstall server-monitoring-stack -n server-monitoring
 
 commands:
   notify_failing_main:

Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: circleci-server-monitoring-stack
+name: server-monitoring-stack
 description: A reference Helm chart for setting up a monitoring stack for CircleCI server
 version: 0.1.0-alpha.0
 dependencies:

README.md

@@ -5,7 +5,7 @@ A reference for tools, configurations, and documentation used to monitor CircleC
 
 This repository is currently under active development and is not yet a supported resource. Please refer to it at your own discretion until further notice.
 
-# circleci-server-monitoring-stack
+# server-monitoring-stack
 
 A reference Helm chart for setting up a monitoring stack for CircleCI server
 
@@ -34,25 +34,32 @@ telegraf:
           listen: ":9273"
 ```
 
-### 2. Install Dependencies
+### 3. Add Helm Repository
+
+First, add the CircleCI Server Monitoring Stack Helm repository:
+```bash
+$ helm repo add server-monitoring-stack https://packagecloud.io/circleci/server-monitoring-stack/helm
+$ helm repo update
+```
+
+### 3. Install Dependencies
 
 Before installing the full chart, you must first install the dependency subcharts, including the Prometheus Custom Resource Definitions (CRDs) and the Grafana operator chart. This assumes you are installing it in the same namespace as your CircleCI server installation:
 
 ```bash
-$ helm install circleci-server-monitoring-stack . --dependency-update --set global.enabled=false --set prometheusOperator.installCRDs=true -n <your-server-namespace>
+$ helm install server-monitoring-stack server-monitoring-stack/server-monitoring-stack --dependency-update --set global.enabled=false --set prometheusOperator.installCRDs=true --version 0.1.0-alpha.0 -n <your-server-namespace>
 ```
-
 > **_NOTE:_**  It's possible to install the monitoring stack in a different namespace than the CircleCI server installation. If you do so, set the `prometheus.serviceMonitor.selectorNamespaces` value with the target namespace.
 
-### 3. Install the Helm Chart
+### 4. Install the Helm Chart
 
 Next, install the Helm chart using the following command:
 
 ```bash
-$ helm upgrade --install circleci-server-monitoring-stack . --reset-values -n <your-server-namespace>
+$ helm upgrade --install server-monitoring-stack server-monitoring-stack/server-monitoring-stack --reset-values --version 0.1.0-alpha.0 -n <your-server-namespace>
 ```
 
-### 4. Verify Prometheus Is Up and Targeting Telegraf
+### 5. Verify Prometheus Is Up and Targeting Telegraf
 To verify that Prometheus is working correctly and targeting Telegraf, use the following command to port-forward Prometheus:
 
 ```bash
@@ -63,7 +70,7 @@ Then visit http://localhost:9090/targets in your browser. Verify that Telegraf a
 
 ![Prometheus UI showing Telegraf target as up](docs/images/prometheus-telegraf-targets.png)
 
-### 5. Verify Grafana Is Up and Connected to Prometheus
+### 6. Verify Grafana Is Up and Connected to Prometheus
 
 To verify that Grafana is working correctly and connected to Prometheus, use the following command to port-forward Grafana:
 ```bash
@@ -74,7 +81,7 @@ Then visit http://localhost:3000 in your browser. Once logged in with the defaul
 
 ![Prometheus UI showing Telegraf target as up](docs/images/grafana-dashboards.png)
 
-### 6. Next Steps
+### 7. Next Steps
 
 After ensuring both Prometheus and Grafana are operational, consider these enhancements:
 
@@ -166,3 +173,7 @@ grafana:
 | prometheusOperator.prometheusConfigReloader.image.repository | string | `"quay.io/prometheus-operator/prometheus-config-reloader"` | Image repository for Prometheus Config Reloader. |
 | prometheusOperator.prometheusConfigReloader.image.tag | string | `"v0.80.1"` | Tag for the Prometheus Config Reloader image. |
 | prometheusOperator.replicas | int | `1` | Number of Prometheus Operator replicas to deploy. |
+
+## Releasing
+
+Releases are managed by the CI/CD pipeline on the main branch, with an approval job gate called `approve-deploy-chart`. Before releasing, increment the Helm chart version in `Chart.yaml` and regenerate the documentation using `./do helm-docs`. Once approved, the release will be available in the [package repository](https://packagecloud.io/circleci/server-monitoring-stack).

README.md.gotmpl

@@ -28,25 +28,32 @@ telegraf:
           listen: ":9273"
 ```
 
-### 2. Install Dependencies
+### 3. Add Helm Repository
+
+First, add the CircleCI Server Monitoring Stack Helm repository:
+```bash
+$ helm repo add {{ template "chart.name" . }} https://packagecloud.io/circleci/server-monitoring-stack/helm
+$ helm repo update
+```
+
+### 3. Install Dependencies
 
 Before installing the full chart, you must first install the dependency subcharts, including the Prometheus Custom Resource Definitions (CRDs) and the Grafana operator chart. This assumes you are installing it in the same namespace as your CircleCI server installation:
 
 ```bash
-$ helm install {{ template "chart.name" . }} . --dependency-update --set global.enabled=false --set prometheusOperator.installCRDs=true -n <your-server-namespace>
+$ helm install {{ template "chart.name" . }} {{ template "chart.name" . }}/{{ template "chart.name" . }} --dependency-update --set global.enabled=false --set prometheusOperator.installCRDs=true --version {{ template "chart.version" . }} -n <your-server-namespace>
 ```
-
 > **_NOTE:_**  It's possible to install the monitoring stack in a different namespace than the CircleCI server installation. If you do so, set the `prometheus.serviceMonitor.selectorNamespaces` value with the target namespace.
 
-### 3. Install the Helm Chart
+### 4. Install the Helm Chart
 
 Next, install the Helm chart using the following command:
 
 ```bash
-$ helm upgrade --install {{ template "chart.name" . }} . --reset-values -n <your-server-namespace>
+$ helm upgrade --install {{ template "chart.name" . }} {{ template "chart.name" . }}/{{ template "chart.name" . }} --reset-values --version {{ template "chart.version" . }} -n <your-server-namespace>
 ```
 
-### 4. Verify Prometheus Is Up and Targeting Telegraf
+### 5. Verify Prometheus Is Up and Targeting Telegraf
 To verify that Prometheus is working correctly and targeting Telegraf, use the following command to port-forward Prometheus:
 
 ```bash
@@ -57,7 +64,7 @@ Then visit http://localhost:9090/targets in your browser. Verify that Telegraf a
 
 ![Prometheus UI showing Telegraf target as up](docs/images/prometheus-telegraf-targets.png)
 
-### 5. Verify Grafana Is Up and Connected to Prometheus
+### 6. Verify Grafana Is Up and Connected to Prometheus
 
 To verify that Grafana is working correctly and connected to Prometheus, use the following command to port-forward Grafana:
 ```bash
@@ -68,7 +75,7 @@ Then visit http://localhost:3000 in your browser. Once logged in with the defaul
 
 ![Prometheus UI showing Telegraf target as up](docs/images/grafana-dashboards.png)
 
-### 6. Next Steps
+### 7. Next Steps
 
 After ensuring both Prometheus and Grafana are operational, consider these enhancements:
 
@@ -108,3 +115,7 @@ grafana:
 > **_NOTE:_** Use a custom storage class with a 'Retain' policy to secure data integrity.
 
 {{ template "chart.valuesSection" . }}
+
+## Releasing
+
+Releases are managed by the CI/CD pipeline on the main branch, with an approval job gate called `approve-deploy-chart`. Before releasing, increment the Helm chart version in `Chart.yaml` and regenerate the documentation using `./do helm-docs`. Once approved, the release will be available in the [package repository](https://packagecloud.io/circleci/server-monitoring-stack).

do

@@ -70,7 +70,7 @@ package-chart() {
         helm package --sign --key "${KEY:-<eng-on-prem@circleci.com>}" --keyring ${KEYRING:-~/.gnupg/secring.gpg} \
           --destination ./target . "$@"
         echo 'Verifying Helm chart signature'
-        helm verify ./target/circleci-server-monitoring-stack-"$(version)".tgz
+        helm verify ./target/server-monitoring-stack-"$(version)".tgz
         ;;
     *)
         helm package --destination ./target .