Skip to content

Commit

Permalink
cnl-quickstart: fix afterinstall instructions formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
xannz committed Nov 15, 2024
1 parent 0416cb0 commit d482c62
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion charts/cnl-quickstart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.11
version: 0.1.12

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
17 changes: 15 additions & 2 deletions charts/cnl-quickstart/site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@ afterInstallationManual: |
In the sections below you can find a short descriptions and info on how to get started with each of these tools.
## ArgoCD
Purpose: GitOps
Purpose: GitOps
Namespace: `argocd`
Short description: Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
Usage:
1. Retrieve the admin password from the secret `argocd-initial-admin-secret`:
```bash
Expand All @@ -43,14 +46,18 @@ afterInstallationManual: |
## Kafka
Purpose: Message broker
Namespace: `kafka`
Short description: Kafka is primarily used to build real-time streaming data pipelines and applications that adapt to the data streams. It combines messaging, storage, and stream processing to allow storage and analysis of both historical and real-time data.
Usage:
CNL quickstart uses the [Strimzi Kafka operator](https://strimzi.io/documentation/). A single broker using KRaft is deployed. You can write (produce) messages to a topic with:
```bash
kubectl -n kafka run kafka-producer -ti --image=quay.io/strimzi/kafka:0.44.0-kafka-3.8.0 --rm=true --restart=Never -- bin/kafka-console-producer.sh --bootstrap-server cnl-kafka-kafka-bootstrap:9092 --topic my-topic
```
Notice the `--bootstrap-server` argument matches the bootstrap service in the `kafka` namespace. The topic will be automatically created. Reading from the same topic can be done with the following:
```bash
Expand All @@ -59,21 +66,27 @@ afterInstallationManual: |
## Prometheus
Purpose: Monitoring and alerting toolkit
Namespace: `monitoring`
Short description: Prometheus is typically used to collect numeric metrics from services that run 24/7 and allow metric data to be accessed via HTTP endpoints.
Usage: CNL quickstart uses the [Prometheus operator](https://prometheus-operator.dev/).
## Grafana
Purpose: Analyze and visualize data
Namespace: `monitoring`
Short description: Interactive visualization web application. It can produce charts, graphs, and alerts for the web when connected to supported data sources.
Usage:
CNL quickstart uses the [Grafana operator](https://grafana.github.io/grafana-operator/docs/). Access the UI by port forwarding the grafana service:
```bash
kubectl -n monitoring port-forward service/grafana-service 3000:3000
```
Then navigate to http://localhost:3000 and use the credentials `root/secret`.
Then navigate to http://localhost:3000 and use the credentials `root/secret`. A dashboard to monitor Kafka is preinstalled using Prometheus as datasource.
namespaces:
Expand Down

0 comments on commit d482c62

Please sign in to comment.