Skip to content

Commit

Permalink
fix documentation format
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Trent <[email protected]>
  • Loading branch information
trent-s committed Jul 16, 2024
1 parent 45d6858 commit 82d7f21
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 21 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Kepler is assumed to be installed in the cluster.

Follow these instructions to install the SusQL Operator with Helm.
- [Installation with Helm](doc/helm-installation.md)
Follow these instructions to install the SusQL Operator from [OperatorHub.](https://operatorhub.io).

Follow these instructions to install the SusQL Operator from [OperatorHub](https://operatorhub.io).
- [Installation with OperatorHub](doc/operatorhub-installation.md)


Expand Down Expand Up @@ -60,25 +61,6 @@ Energy of the group of pods is exposed in 2 ways:
* Through Prometheus at `http://prometheus-susql.openshift-kepler-operator.svc.cluster.local:9090` using the query `susql_total_energy_joules{susql_label_1=my-label-1,susql_label_2=my-label-2}`
* From `status` of the `LabelGroup` CRD given as `labelgroup.status.totalEnergy`

### Installation Configuration Options

| Environmental Variable | Default Value | Description |
|:---------------------------:|:-----------------------------:|:------------------------------------------------:|
| SUSQL_NAMESPACE | openshift-kepler-operator | namespace that SusQL resources run in |
| KEPLER_PROMETHEUS_NAMESPACE | openshift-monitoring | namespace that Kepler Prometheus runs in |
| PROMETHEUS_PROTOCOL | http | Either http or https for Kepler Prometheus access|
| PROMETHEUS_SERVICE | prometheus-k8s | service name for the Kepler Prometheus |
| PROMETHEUS_NAMESPACE | monitoring | namespace used by the Kepler Prometheus |
| PROMETHEUS_DOMAIN | svc.cluster.local | Domain used by the Kepler Prometheus |
| PROMETHEUS_PORT | 9090 | Port used by the Kepler Prometheus |
| KEPLER_PROMETHEUS_URL | http://prometheus-k8s.monitoring.svc.cluster.local:9090 | A shortcut to specify final Kepler Prometheus URL |
| KEPLER_METRIC_NAME | kepler_container_joules_total | Metric queried in the Kepler Prometheus |
| SUSQL_PROMETHEUS_URL | http://prometheus-susql.openshift-kepler-operator.svc.cluster.local:9090 | SusQL Prometheus URL |
| SUSQL_SAMPLING_RATE | 2 | Sampling rate in seconds |
| SUSQL_ENHANCED | | If set to any string, then use enhanced RBAC and SMON configuration |
| SUSQL_REGISTRY | quay.io/sustainable_computing_io | Container registry that SusQL is stored in |
| SUSQL_IMAGE_NAME | susql_operator | Image name used on SusQL container registry |
| SUSQL_IMAGE_TAG | latest | Tag for SusQL container |


## License
Expand Down
2 changes: 1 addition & 1 deletion doc/helm-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Instructions to install SusQL via Helm.

### Prerequisites

Kepler is assumed to be installed in the cluster. `helm`, `kubectl`, and `go` are also required to deploy.
Kepler is assumed to be installed in the cluster. `helm`, `kubectl`, and `go` are also required to deploy with Helm.

### Installation

Expand Down

0 comments on commit 82d7f21

Please sign in to comment.