Skip to content

Commit

Permalink
AUTO: Sync Helm Charts docs to ScalarDB Enterprise docs site repo
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed Apr 9, 2024
1 parent 2413564 commit cc7d278
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 32 deletions.
5 changes: 0 additions & 5 deletions docs/latest/helm-charts/configure-custom-values-envoy.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,11 +144,6 @@ envoy:
repository: <SCALAR_ENVOY_CONTAINER_IMAGE>
```

If you're using AWS or Azure, please refer to the following documents for more details:

* [How to install Scalar products through AWS Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AwsMarketplaceGuide.md)
* [How to install Scalar products through Azure Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AzureMarketplaceGuide.md)

### Replica configurations (Optional based on your environment)

You can specify the number of replicas (pods) of Scalar Envoy using `envoy.replicaCount`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,7 @@ auditor:
repository: <SCALARDL_AUDITOR_CONTAINER_IMAGE>
```

If you're using AWS or Azure, please refer to the following documents for more details:

* [How to install Scalar products through AWS Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AwsMarketplaceGuide.md)
* [How to install Scalar products through Azure Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AzureMarketplaceGuide.md)
For more details on the container repository for Scalar products, see [How to get the container images of Scalar products](../scalar-kubernetes/HowToGetContainerImages.md).

### Auditor/Database configurations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,7 @@ ledger:
repository: <SCALARDL_LEDGER_CONTAINER_IMAGE>
```

If you're using AWS or Azure, please refer to the following documents for more details:

* [How to install Scalar products through AWS Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AwsMarketplaceGuide.md)
* [How to install Scalar products through Azure Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AzureMarketplaceGuide.md)
For more details on the container repository for Scalar products, see [How to get the container images of Scalar products](../scalar-kubernetes/HowToGetContainerImages.md).

### Ledger/Database configurations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,6 @@ This document explains how to create your custom values file for the ScalarDL Sc

## Required configurations

### Image configurations

You must set `schemaLoading.image.repository`. Be sure to specify the ScalarDL Schema Loader container image so that you can pull the image from the container repository.

```yaml
schemaLoading:
image:
repository: <SCALARDL_SCHEMA_LOADER_CONTAINER_IMAGE>
```
If you're using AWS or Azure, please refer to the following documents for more details:
* [How to install Scalar products through AWS Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AwsMarketplaceGuide.md)
* [How to install Scalar products through Azure Marketplace](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AzureMarketplaceGuide.md)
### Database configurations

You must set `schemaLoading.databaseProperties`. Please set your `database.properties` to access the backend database to this parameter. Please refer to the [Getting Started with ScalarDB](https://github.com/scalar-labs/scalardb/blob/master/docs/getting-started-with-scalardb.md) for more details on the database configuration of ScalarDB.
Expand Down Expand Up @@ -66,6 +51,16 @@ schemaLoading:
secretName: "schema-loader-credentials-secret"
```

### Image configurations (Default value is recommended)

If you want to change the image repository, you can use `schemaLoading.image.repository` to specify which repository you want to use to pull the ScalarDL Schema Loader container image from.

```yaml
schemaLoading:
image:
repository: <SCALARDL_SCHEMA_LOADER_CONTAINER_IMAGE>
```

### Flags configurations (Optional based on your environment)

You can specify several flags as an array. Please refer to the document [ScalarDB Schema Loader](https://github.com/scalar-labs/scalardb/blob/master/docs/schema-loader.md) for more details on the flags.
Expand Down
12 changes: 8 additions & 4 deletions docs/latest/helm-charts/how-to-deploy-scalar-products.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,16 @@ You must prepare your custom values file based on your environment. Please refer

* [Configure a custom values file for Scalar Helm Charts](configure-custom-values-file.md)

### Create a Secret resource for authentication of the container registry (Optional)
### Get the container images

If you use a Kubernetes cluster other than EKS or AKS, you need to create a Secret resource that includes the credentials and set the Secret name to `imagePullSecrets[].name` in your custom values file. Please refer to the following documents for more details on creating the Secret resource and setting it in your custom values file.
If you're using commercially licensed Scalar products, you must get the container images of those products. For details, see [How to get the container images of Scalar products](../scalar-kubernetes/HowToGetContainerImages.md).

* [Deploy containers on Kubernetes other than EKS from AWS Marketplace using Scalar Helm Charts](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AwsMarketplaceGuide.md#byol-deploy-containers-on-kubernetes-other-than-eks-from-aws-marketplace-using-scalar-helm-charts)
* [Deploy containers on Kubernetes other than AKS (Azure Kubernetes Service) from your private container registry using Scalar Helm Charts](https://github.com/scalar-labs/scalar-kubernetes/blob/master/docs/AzureMarketplaceGuide.md#deploy-containers-on-kubernetes-other-than-aks-azure-kubernetes-service-from-your-private-container-registry-using-scalar-helm-charts)
If you're using any of the following products from the public container repository, you can get the container images from the public container repository with the default configuration of Scalar Helm Chart:

* Scalar Envoy (deploy with ScalarDB Cluster, ScalarDL Ledger, or ScalarDL Auditor)
* ScalarDL Schema Loader
* Scalar Admin for Kubernetes
* ScalarDB Analytics with PostgreSQL

## Deploy Scalar products

Expand Down

0 comments on commit cc7d278

Please sign in to comment.