Skip to content

Commit

Permalink
Merge pull request #176 from scalar-labs/helm-charts/en-us/3.12-docs-…
Browse files Browse the repository at this point in the history
…update

AUTO: Docs repo sync - Helm Charts
  • Loading branch information
josh-wong authored Feb 26, 2024
2 parents 123984f + 58ea83f commit b04048b
Show file tree
Hide file tree
Showing 49 changed files with 834 additions and 287 deletions.
8 changes: 4 additions & 4 deletions docs/3.12/helm-charts/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Index

## For users
* [Getting Started with Scalar Helm Charts](./getting-started-scalar-helm-charts.md)
* [Configure a custom values file for Scalar Helm Chart](./configure-custom-values-file.md)
* [Deploy Scalar products using Scalar Helm Charts](./how-to-deploy-scalar-products.md)
* [Getting Started with Scalar Helm Charts](getting-started-scalar-helm-charts.md)
* [Configure a custom values file for Scalar Helm Chart](configure-custom-values-file.md)
* [Deploy Scalar products using Scalar Helm Charts](how-to-deploy-scalar-products.md)

## For developers
* [Release Flow](./ReleaseFlow.md)
* [Release Flow](ReleaseFlow.md)
24 changes: 24 additions & 0 deletions docs/3.12/helm-charts/ReleaseFlow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Release Flow

## Requirements
| Name | Version | Mandatory | link |
|:------|:-------|:----------|:------|
| Helm | 3.2.1 or latest | no | https://helm.sh/docs/intro/install/ |

## Release
* You create a branch (`prepare-release-*`).
* You make sure to create the tag from the previous version of the target version.
``` console
$ git checkout -b prepare-release-v3.0.2 refs/tags/scalardl-3.0.1
```

* You need to set the `version` of the `Chart.yaml` of each `helm-charts` to the version to be released.
``` yaml
version: 3.0.2
```
* Pushing commits to a remote repository.
``` console
$ git push origin prepare-release-v3.0.2
```

* In this case, the `Github Actions` for the release will be executed upon `Git push`.
25 changes: 25 additions & 0 deletions docs/3.12/helm-charts/conf/scalar-loki-stack-custom-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,28 @@ promtail:
- __meta_kubernetes_pod_uid
- __meta_kubernetes_pod_container_name
target_label: __path__
# -- the `scalar-admin-for-kubernetes` job scrapes all the logs of Scalar Admin for Kubernetes Pods
- job_name: scalar-admin-for-kubernetes
pipeline_stages:
- docker: {}
- cri: {}
kubernetes_sd_configs:
- role: pod
relabel_configs:
- source_labels:
- __meta_kubernetes_pod_node_name
target_label: __host__
- action: replace
source_labels:
- __meta_kubernetes_pod_name
target_label: pod
- action: keep
regex: (.*)scalar-admin-for-kubernetes-(.+)
source_labels:
- pod
- replacement: /var/log/pods/*$1/*.log
separator: /
source_labels:
- __meta_kubernetes_pod_uid
- __meta_kubernetes_pod_container_name
target_label: __path__
20 changes: 10 additions & 10 deletions docs/3.12/helm-charts/configure-custom-values-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

When you deploy Scalar products using Scalar Helm Charts, you must prepare your custom values file based on your environment. Please refer to the following documents for more details on how to a create custom values file for each product.

* [ScalarDB Cluster](./configure-custom-values-scalardb-cluster.md)
* [ScalarDB Analytics with PostgreSQL](./configure-custom-values-scalardb-analytics-postgresql.md)
* [ScalarDL Ledger](./configure-custom-values-scalardl-ledger.md)
* [ScalarDL Auditor](./configure-custom-values-scalardl-auditor.md)
* [ScalarDL Schema Loader](./configure-custom-values-scalardl-schema-loader.md)
* [Scalar Admin for Kubernetes](./configure-custom-values-scalar-admin-for-kubernetes.md)
* [Scalar Manager](./configure-custom-values-scalar-manager.md)
* [Envoy](./configure-custom-values-envoy.md)
* [[Deprecated] ScalarDB Server](./configure-custom-values-scalardb.md)
* [[Deprecated] ScalarDB GraphQL](./configure-custom-values-scalardb-graphql.md)
* [ScalarDB Cluster](configure-custom-values-scalardb-cluster.md)
* [ScalarDB Analytics with PostgreSQL](configure-custom-values-scalardb-analytics-postgresql.md)
* [ScalarDL Ledger](configure-custom-values-scalardl-ledger.md)
* [ScalarDL Auditor](configure-custom-values-scalardl-auditor.md)
* [ScalarDL Schema Loader](configure-custom-values-scalardl-schema-loader.md)
* [Scalar Admin for Kubernetes](configure-custom-values-scalar-admin-for-kubernetes.md)
* [Scalar Manager](configure-custom-values-scalar-manager.md)
* [Envoy](configure-custom-values-envoy.md)
* [[Deprecated] ScalarDB Server](configure-custom-values-scalardb.md)
* [[Deprecated] ScalarDB GraphQL](configure-custom-values-scalardb-graphql.md)
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To use environment variables to set some properties, like credentials, in `scala

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) by using environment variables, which makes your pods more secure.

For more details on how to use a secret resource, see [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md).
For more details on how to use a secret resource, see [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md).

```yaml
scalardbAnalyticsPostgreSQL:
Expand Down Expand Up @@ -164,7 +164,7 @@ scalardbAnalyticsPostgreSQL:
{% capture notice--info %}
**Note**

You must create a secret resource with this name (`scalardb-analytics-postgresql-superuser-password` by default) before you deploy ScalarDB Analytics with PostgreSQL. For details, see [Prepare a secret resource](./how-to-deploy-scalardb-analytics-postgresql.md#prepare-a-secret-resource).
You must create a secret resource with this name (`scalardb-analytics-postgresql-superuser-password` by default) before you deploy ScalarDB Analytics with PostgreSQL. For details, see [Prepare a secret resource](how-to-deploy-scalardb-analytics-postgresql.md#prepare-a-secret-resource).
{% endcapture %}

<div class="notice--info">{{ notice--info | markdownify }}</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ To use environment variables to set some properties (e.g., credentials) in `scal

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) by using environment variables, which makes your pods more secure.

For more details on how to use a Secret resource, see [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md).
For more details on how to use a Secret resource, see [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md).

```yaml
scalardbCluster:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% capture notice--info %}
**Note**

ScalarDB GraphQL Server is now deprecated. Please use [ScalarDB Cluster](./configure-custom-values-scalardb-cluster.md) instead.
ScalarDB GraphQL Server is now deprecated. Please use [ScalarDB Cluster](configure-custom-values-scalardb-cluster.md) instead.
{% endcapture %}

<div class="notice--info">{{ notice--info | markdownify }}</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/3.12/helm-charts/configure-custom-values-scalardb.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% capture notice--info %}
**Note**

ScalarDB Server is now deprecated. Please use [ScalarDB Cluster](./configure-custom-values-scalardb-cluster.md) instead.
ScalarDB Server is now deprecated. Please use [ScalarDB Cluster](configure-custom-values-scalardb-cluster.md) instead.
{% endcapture %}

<div class="notice--info">{{ notice--info | markdownify }}</div>
Expand Down Expand Up @@ -91,7 +91,7 @@ If you want to use environment variables to set some properties (e.g., credentia

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) using environment variables, which makes your pods more secure.

Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md) for more details on how to use a Secret resource.
Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md) for more details on how to use a Secret resource.

```yaml
scalardb:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You must set a private key file to `scalar.dl.auditor.private_key_path` and a ce

You must also mount the private key file and the certificate file on the ScalarDL Auditor pod.

For more details on how to mount the private key file and the certificate file, refer to [Mount key and certificate files on a pod in ScalarDL Helm Charts](./mount-files-or-volumes-on-scalar-pods.md#mount-key-and-certificate-files-on-a-pod-in-scalardl-helm-charts).
For more details on how to mount the private key file and the certificate file, refer to [Mount key and certificate files on a pod in ScalarDL Helm Charts](mount-files-or-volumes-on-scalar-pods.md#mount-key-and-certificate-files-on-a-pod-in-scalardl-helm-charts).

## Optional configurations

Expand Down Expand Up @@ -86,7 +86,7 @@ If you want to use environment variables to set some properties (e.g., credentia

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) using environment variables, which makes your pods more secure.

Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md) for more details on how to use a Secret resource.
Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md) for more details on how to use a Secret resource.

```yaml
auditor:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you set `scalar.dl.ledger.proof.enabled` to `true` (this configuration is req

In this case, you must mount the private key file on the ScalarDL Ledger pod.

For more details on how to mount the private key file, refer to [Mount key and certificate files on a pod in ScalarDL Helm Charts](./mount-files-or-volumes-on-scalar-pods.md#mount-key-and-certificate-files-on-a-pod-in-scalardl-helm-charts).
For more details on how to mount the private key file, refer to [Mount key and certificate files on a pod in ScalarDL Helm Charts](mount-files-or-volumes-on-scalar-pods.md#mount-key-and-certificate-files-on-a-pod-in-scalardl-helm-charts).

## Optional configurations

Expand Down Expand Up @@ -86,7 +86,7 @@ If you want to use environment variables to set some properties (e.g., credentia

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) using environment variables, which makes your pods more secure.

Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md) for more details on how to use a Secret resource.
Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md) for more details on how to use a Secret resource.

```yaml
ledger:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If you want to use environment variables to set some properties (e.g., credentia

For example, you can set credentials for a backend database (`scalar.db.username` and `scalar.db.password`) using environment variables, which makes your pods more secure.

Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](./use-secret-for-credentials.md) for more details on how to use a Secret resource.
Please refer to the document [How to use Secret resources to pass the credentials as the environment variables into the properties file](use-secret-for-credentials.md) for more details on how to use a Secret resource.

```yaml
schemaLoading:
Expand Down
9 changes: 2 additions & 7 deletions docs/3.12/helm-charts/getting-started-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document explains how to get started with log aggregation for Scalar products on Kubernetes using Grafana Loki (with Promtail).

We assume that you have already read the [getting-started with monitoring](./getting-started-monitoring.md) for Scalar products and installed kube-prometheus-stack.
We assume that you have already read the [getting-started with monitoring](getting-started-monitoring.md) for Scalar products and installed kube-prometheus-stack.

## What we create

Expand Down Expand Up @@ -42,26 +42,23 @@ We will deploy the following components on a Kubernetes cluster as follows.

## Step 1. Prepare a custom values file

1. Get the sample file [scalar-loki-stack-custom-values.yaml](./conf/scalar-loki-stack-custom-values.yaml) for the `loki-stack` helm chart.
1. Get the sample file [scalar-loki-stack-custom-values.yaml](conf/scalar-loki-stack-custom-values.yaml) for the `loki-stack` helm chart.

## Step 2. Deploy `loki-stack`

1. Add the `grafana` helm repository.

```console
helm repo add grafana https://grafana.github.io/helm-charts
```

1. Deploy the `loki-stack` helm chart.

```console
helm install scalar-logging-loki grafana/loki-stack -n monitoring -f scalar-loki-stack-custom-values.yaml
```

## Step 3. Add a Loki data source in the Grafana configuration

1. Add a configuration of the Loki data source in the `scalar-prometheus-custom-values.yaml` file.

```yaml
grafana:
additionalDataSources:
Expand All @@ -75,7 +72,6 @@ We will deploy the following components on a Kubernetes cluster as follows.
```
1. Apply the configuration (upgrade the deployment of `kube-prometheus-stack`).

```console
helm upgrade scalar-monitoring prometheus-community/kube-prometheus-stack -n monitoring -f scalar-prometheus-custom-values.yaml
```
Expand All @@ -90,7 +86,6 @@ We will deploy the following components on a Kubernetes cluster as follows.
## Step 5. Delete the `loki-stack` helm chart

1. Uninstall `loki-stack`.

```console
helm uninstall scalar-logging-loki -n monitoring
```
10 changes: 5 additions & 5 deletions docs/3.12/helm-charts/getting-started-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ We will deploy the following components on a Kubernetes cluster as follows.

## Step 1. Start a Kubernetes cluster

First, you need to prepare a Kubernetes cluster. If you use a **minikube** environment, please refer to the [Getting Started with Scalar Helm Charts](./getting-started-scalar-helm-charts.md). If you have already started a Kubernetes cluster, you can skip this step.
First, you need to prepare a Kubernetes cluster. If you use a **minikube** environment, please refer to the [Getting Started with Scalar Helm Charts](getting-started-scalar-helm-charts.md). If you have already started a Kubernetes cluster, you can skip this step.

## Step 2. Prepare a custom values file

1. Save the sample file [scalar-prometheus-custom-values.yaml](./conf/scalar-prometheus-custom-values.yaml) for `kube-prometheus-stack`.
1. Save the sample file [scalar-prometheus-custom-values.yaml](conf/scalar-prometheus-custom-values.yaml) for `kube-prometheus-stack`.

1. Add custom values in the `scalar-prometheus-custom-values.yaml` as follows.
* settings
Expand Down Expand Up @@ -96,9 +96,9 @@ First, you need to prepare a Kubernetes cluster. If you use a **minikube** envir

* Note:
* The following explains the minimum steps. If you want to know more details about the deployment of ScalarDB and ScalarDL, please refer to the following documents.
* [Getting Started with Helm Charts (ScalarDB Server)](./getting-started-scalardb.md)
* [Getting Started with Helm Charts (ScalarDL Ledger / Ledger only)](./getting-started-scalardl-ledger.md)
* [Getting Started with Helm Charts (ScalarDL Ledger and Auditor / Auditor mode)](./getting-started-scalardl-auditor.md)
* [Getting Started with Helm Charts (ScalarDB Server)](getting-started-scalardb.md)
* [Getting Started with Helm Charts (ScalarDL Ledger / Ledger only)](getting-started-scalardl-ledger.md)
* [Getting Started with Helm Charts (ScalarDL Ledger and Auditor / Auditor mode)](getting-started-scalardl-auditor.md)

1. To enable Prometheus monitoring of Scalar products, set `true` to the following configurations in the custom values file.
* Configurations
Expand Down
14 changes: 7 additions & 7 deletions docs/3.12/helm-charts/getting-started-scalar-helm-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ First, you need to install the following tools used in this guide.

After the Kubernetes cluster starts, you can try each Scalar Helm Charts on it. Please refer to the following documents for more details.

* [ScalarDB Analytics with PostgreSQL](./getting-started-scalardb-analytics-postgresql.md)
* [ScalarDL Ledger (Ledger only)](./getting-started-scalardl-ledger.md)
* [ScalarDL Ledger and Auditor (Auditor mode)](./getting-started-scalardl-auditor.md)
* [Monitoring using Prometheus Operator](./getting-started-monitoring.md)
* [Logging using Loki Stack](./getting-started-logging.md)
* [Scalar Manager](./getting-started-scalar-manager.md)
* [[Deprecated] ScalarDB Server](./getting-started-scalardb.md)
* [ScalarDB Analytics with PostgreSQL](getting-started-scalardb-analytics-postgresql.md)
* [ScalarDL Ledger (Ledger only)](getting-started-scalardl-ledger.md)
* [ScalarDL Ledger and Auditor (Auditor mode)](getting-started-scalardl-auditor.md)
* [Monitoring using Prometheus Operator](getting-started-monitoring.md)
* [Logging using Loki Stack](getting-started-logging.md)
* [Scalar Manager](getting-started-scalar-manager.md)
* [[Deprecated] ScalarDB Server](getting-started-scalardb.md)
Loading

0 comments on commit b04048b

Please sign in to comment.