Update release-drafter.yml

Signed-off-by: Weifeng Wang <[email protected]> Update README.md
qclaogui · Mar 27, 2024 · 58d1a45 · 58d1a45
1 parent 753cf91
commit 58d1a45
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 30 deletions.
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -58,21 +58,21 @@ footer: |
 
   | Port-mapping | Component | Description |
   | --- | --- | --- |
-  | `12345:12345` | [Grafana Agent][7] | Eexpose `12345` port so we can directly access `grafana-agent` inside container |
-  | `33100:3100` | [Loki][1] | Expose `33100` port so we can directly access `loki` inside container |
-  | `3000:3000` | [Grafana][2] | Expose `3000` port so we can directly access `grafana` inside container |
-  | `33200:3200` | [Tempo][3] | Expose `33200` port so we can directly access `tempo` inside container |
-  | `38080:8080` | [Mimir][4] | Expose `38080` port so we can directly access `mimir` inside container |
-  | `34040:4040` | [Pyroscope][5] | Expose `34040` port so we can directly access `pyroscope` inside container |
-  | `9001:9001` | [Minio][6] | Expose `9001` port so we can access `minio` console with `MINIO_ROOT_USER=lgtmp`, `MINIO_ROOT_PASSWORD=supersecret` |
+  | `12345:12345`, `4317`, `4318`, `6831` | [Grafana Agent][1] | Eexpose `12345` port so we can directly access `grafana-agent` inside container |
+  | `33100:3100` | [Loki][2] | Expose `33100` port so we can directly access `loki` inside container |
+  | `3000:3000`, `6060` | [Grafana][3] | Expose `3000` port so we can directly access `grafana` inside container |
+  | `33200:3200`, `4317`, `4318` | [Tempo][4] | Expose `33200` port so we can directly access `tempo` inside container |
+  | `38080:8080` | [Mimir][5] | Expose `38080` port so we can directly access `mimir` inside container |
+  | `34040:4040` | [Pyroscope][6] | Expose `34040` port so we can directly access `pyroscope` inside container |
+  | `9001:9001`, `9000` | [Minio][7] | Expose `9001` port so we can access `minio` console with `MINIO_ROOT_USER=lgtmp`, `MINIO_ROOT_PASSWORD=supersecret` |
 
-  [7]: https://github.com/grafana/agent
-  [1]: https://github.com/grafana/loki
-  [2]: https://github.com/grafana/grafana
-  [3]: https://github.com/grafana/tempo
-  [4]: https://github.com/grafana/mimir
-  [5]: https://github.com/grafana/pyroscope
-  [6]: https://github.com/minio/minio
+  [1]: https://github.com/grafana/agent
+  [2]: https://github.com/grafana/loki
+  [3]: https://github.com/grafana/grafana
+  [4]: https://github.com/grafana/tempo
+  [5]: https://github.com/grafana/mimir
+  [6]: https://github.com/grafana/pyroscope
+  [7]: https://github.com/minio/minio
 
   ## Helpful Links
 
@@ -83,3 +83,4 @@ footer: |
   - <https://github.com/k3d-io/k3d>
   - <https://github.com/k3s-io/k3s>
   - <https://github.com/grafana/grafana>
+  - [Grafana Agent Configuration Generator](https://github.com/grafana/agent-configurator) a tool allows for easy configuration of Grafana Agents Flow system
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -41,7 +41,10 @@ jobs:
         with:
           token: ${{ secrets.QCBOT_TOKEN }}
           title: Add release notes for ${{ steps.draft.outputs.tag_name }}
-          commit-message: Add release notes for ${{ steps.draft.outputs.tag_name }}
+          commit-message: |
+            Add release notes for ${{ steps.draft.outputs.tag_name }}
+
+            Signed-off-by: 🤖GitHub Actions[Bot] <41898282+github-actions[bot]@users.noreply.github.com>
           committer: 🤖GitHub Actions[Bot] <41898282+github-actions[bot]@users.noreply.github.com>
           body: |
             🤖 Copy release notes from Draft
@@ -56,8 +59,8 @@ jobs:
             </details>
             <br />
 
-            > Auto-generated by [Release Drafter GitHub Action][1]
+            > Auto-generated by [Release Drafter GitHub Action][0]
 
-            [1]: https://github.com/qclaogui/codelab-monitoring/blob/main/.github/workflows/release-drafter.yml
-          labels: kind/improvement, skip-release-notes
+            [0]: https://github.com/qclaogui/codelab-monitoring/blob/main/.github/workflows/release-drafter.yml
+          labels: kind/docs, skip-release-notes
           branch: update-release-notes
diff --git a/README.md b/README.md
@@ -1,20 +1,15 @@
 # Provisioning Scalable Observability Workspace
 
-<p align="center">
-  <a href="https://github.com/qclaogui/codelab-monitoring/actions/workflows/ci.yml">
-    <img src="https://github.com/qclaogui/codelab-monitoring/actions/workflows/ci.yml/badge.svg">
-  </a>
-  <a href="https://github.com/qclaogui/codelab-monitoring/blob/master/LICENSE">
-    <img src="https://img.shields.io/github/license/qclaogui/codelab-monitoring.svg" alt="License">
-  </a>
-  <a href="https://github.com/qclaogui/codelab-monitoring/tags">
-    <img src="https://img.shields.io/github/last-commit/qclaogui/codelab-monitoring" alt="GitHub Last Commit">
-  </a>
-</p>
+![CI](https://github.com/qclaogui/codelab-monitoring/actions/workflows/ci.yml/badge.svg)
+![Go version](https://img.shields.io/github/go-mod/go-version/qclaogui/codelab-monitoring)
+![License](https://img.shields.io/github/license/qclaogui/codelab-monitoring.svg)
+![GitHub Last Commit](https://img.shields.io/github/last-commit/qclaogui/codelab-monitoring)
+
+A simple command to run Grafana LGTMP Stack in Docker or Kubernetes.
 
 ## Quick Start
 
-Open a new terminal window to create `compose.yaml`, an simple use case `compose.yaml` like so:
+Open a new terminal to create `compose.yaml`, an simple use case `compose.yaml` like so:
 
 ```yaml
 # include is available in Docker Compose version 2.20 and later, and Docker Desktop version 4.22 and later.
@@ -251,3 +246,34 @@ Flags:
 
 Use "lgtmp [command] --help" for more information about a command.
 ```
+
+## Grafana LGTMP Stack default port-mapping
+
+| Port-mapping | Component | Description |
+| --- | --- | --- |
+| `12345:12345`, `4317`, `4318`, `6831` | [Grafana Agent][1] | Eexpose `12345` port so we can directly access `grafana-agent` inside container |
+| `33100:3100` | [Loki][2] | Expose `33100` port so we can directly access `loki` inside container |
+| `3000:3000`, `6060` | [Grafana][3] | Expose `3000` port so we can directly access `grafana` inside container |
+| `33200:3200`, `4317`, `4318` | [Tempo][4] | Expose `33200` port so we can directly access `tempo` inside container |
+| `38080:8080` | [Mimir][5] | Expose `38080` port so we can directly access `mimir` inside container |
+| `34040:4040` | [Pyroscope][6] | Expose `34040` port so we can directly access `pyroscope` inside container |
+| `9001:9001`, `9000` | [Minio][7] | Expose `9001` port so we can access `minio` console with `MINIO_ROOT_USER=lgtmp`, `MINIO_ROOT_PASSWORD=supersecret` |
+
+[1]: https://github.com/grafana/agent
+[2]: https://github.com/grafana/loki
+[3]: https://github.com/grafana/grafana
+[4]: https://github.com/grafana/tempo
+[5]: https://github.com/grafana/mimir
+[6]: https://github.com/grafana/pyroscope
+[7]: https://github.com/minio/minio
+
+## Helpful Links
+
+- <https://grafana.com/docs/>
+- <https://github.com/grafana/agent-modules>
+- <https://github.com/docker/compose>
+- <https://grafana.com/docs/agent/latest/flow/reference/components/>
+- <https://github.com/k3d-io/k3d>
+- <https://github.com/k3s-io/k3s>
+- <https://github.com/grafana/grafana>
+- [Grafana Agent Configuration Generator](https://github.com/grafana/agent-configurator) a tool allows for easy configuration of Grafana Agents Flow system