Skip to content

Commit

Permalink
Merge pull request #2 from datalayer/helm/docs-1
Browse files Browse the repository at this point in the history
Align values for iam, operator and jupyter + generate docs with helm-docs
  • Loading branch information
fcollonval authored Jul 11, 2024
2 parents d1ccaf6 + a3f5584 commit 92d3826
Show file tree
Hide file tree
Showing 13 changed files with 344 additions and 90 deletions.
11 changes: 8 additions & 3 deletions datalayer-iam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,25 @@ Datalayer IAM
|-----|------|---------|-------------|
| iam.certificateIssuer | string | `"letsencrypt"` | |
| iam.clusterType | string | `"any"` | |
| iam.env.DATALAYER_AUTHZ_ENGINE | string | `""` | |
| iam.env.DATALAYER_AUTHZ_ENGINE | string | `"openfga"` | |
| iam.env.DATALAYER_CDN_URL | string | `""` | |
| iam.env.DATALAYER_CREDITS_PROVIDER | string | `""` | |
| iam.env.DATALAYER_GITHUB_CLIENT_ID | string | `""` | |
| iam.env.DATALAYER_GITHUB_CLIENT_SECRET | string | `""` | |
| iam.env.DATALAYER_IAM_API_KEY | string | `""` | |
| iam.env.DATALAYER_JWT_ALGORITHM | string | `""` | |
| iam.env.DATALAYER_JWT_ISSUER | string | `""` | |
| iam.env.DATALAYER_JWT_ALLOWED_ISSUERS | string | `""` | |
| iam.env.DATALAYER_JWT_DEFAULT_KID_ISSUER | string | `""` | |
| iam.env.DATALAYER_JWT_ISSUER | string | `"https://id.datalayer.run"` | |
| iam.env.DATALAYER_JWT_SECRET | string | `""` | |
| iam.env.DATALAYER_JWT_SKIP_3RD_TOKEN_SIGNATURE_VERIFICATION | string | `"false"` | |
| iam.env.DATALAYER_OPENFGA_AUTHZ_MODEL_ID | string | `""` | |
| iam.env.DATALAYER_OPENFGA_REST_URL | string | `"http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"` | |
| iam.env.DATALAYER_OPENFGA_STORE_ID | string | `""` | |
| iam.env.DATALAYER_PUB_SUB_ENGINE | string | `"pulsar"` | |
| iam.env.DATALAYER_PULSAR_URL | string | `"pulsar://datalayer-pulsar-broker.datalayer-pulsar.svc.cluster.local:6650"` | |
| iam.env.DATALAYER_RUNTIME_ENV | string | `"prod"` | |
| iam.env.DATALAYER_RUN_HOST | string | `""` | |
| iam.env.DATALAYER_RUN_HOST | string | `""` | |
| iam.env.DATALAYER_SMTP_HOST | string | `""` | |
| iam.env.DATALAYER_SMTP_PASSWORD | string | `""` | |
| iam.env.DATALAYER_SMTP_PORT | string | `"0"` | |
Expand All @@ -47,6 +51,7 @@ Datalayer IAM
| iam.env.DATALAYER_STRIPE_JS_API_KEY | string | `""` | |
| iam.env.DATALAYER_STRIPE_PRODUCT_ID | string | `""` | |
| iam.env.DATALAYER_STRIPE_WEBHOOK_SECRET | string | `""` | |
| iam.env.DATALAYER_SUPPORT_EMAIL | string | `""` | |
| iam.image | string | `"datalayer/iam:0.1.1"` | |
| iam.imagePullPolicy | string | `"Always"` | |
| iam.ingressClass | string | `"datalayer-traefik"` | |
Expand Down
22 changes: 13 additions & 9 deletions datalayer-iam/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,34 @@ iam:
# memory: "8192Mi"
# cpu: "3000m"
env:
DATALAYER_RUN_HOST: ""
DATALAYER_AUTHZ_ENGINE: "openfga"
DATALAYER_CDN_URL: ""
DATALAYER_RUNTIME_ENV: "prod"
DATALAYER_CREDITS_PROVIDER: ""
DATALAYER_GITHUB_CLIENT_ID: ""
DATALAYER_GITHUB_CLIENT_SECRET: ""
DATALAYER_IAM_API_KEY: ""
DATALAYER_JWT_ISSUER: ""
DATALAYER_JWT_SECRET: ""
DATALAYER_JWT_ALGORITHM: ""
DATALAYER_AUTHZ_ENGINE: ""
DATALAYER_JWT_ALLOWED_ISSUERS: ""
DATALAYER_JWT_DEFAULT_KID_ISSUER: ""
DATALAYER_JWT_ISSUER: "https://id.datalayer.run"
DATALAYER_JWT_SECRET: ""
DATALAYER_JWT_SKIP_3RD_TOKEN_SIGNATURE_VERIFICATION: "false"
DATALAYER_OPENFGA_AUTHZ_MODEL_ID: ""
DATALAYER_OPENFGA_REST_URL: "http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"
DATALAYER_OPENFGA_STORE_ID: ""
DATALAYER_OPENFGA_AUTHZ_MODEL_ID: ""
DATALAYER_PUB_SUB_ENGINE: "pulsar"
DATALAYER_PULSAR_URL: "pulsar://datalayer-pulsar-broker.datalayer-pulsar.svc.cluster.local:6650"
DATALAYER_RUNTIME_ENV: "prod"
DATALAYER_RUN_HOST: ""
DATALAYER_SMTP_HOST: ""
DATALAYER_SMTP_PASSWORD: ""
DATALAYER_SMTP_PORT: "0"
DATALAYER_SMTP_USERNAME: ""
DATALAYER_SOLR_ZK_HOST: "solr-datalayer-solrcloud-zookeeper-headless.datalayer-solr.svc.cluster.local"
DATALAYER_PUB_SUB_ENGINE: "pulsar"
DATALAYER_PULSAR_URL: "pulsar://datalayer-pulsar-broker.datalayer-pulsar.svc.cluster.local:6650"
# Addons
DATALAYER_STRIPE_API_KEY: ""
DATALAYER_STRIPE_JS_API_KEY: ""
DATALAYER_STRIPE_BILLING_ROUTE: "/usage/billing"
DATALAYER_STRIPE_JS_API_KEY: ""
DATALAYER_STRIPE_PRODUCT_ID: ""
DATALAYER_STRIPE_WEBHOOK_SECRET: ""
DATALAYER_SUPPORT_EMAIL: ""
46 changes: 44 additions & 2 deletions datalayer-jump/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# jump

![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![AppVersion: 0.0.6](https://img.shields.io/badge/AppVersion-0.0.6-informational?style=flat-square)

Datalayer Jump

**Homepage:** <https://datalayer.io>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Source Code

* <https://github.com/datalayer/services/tree/main/plane/etc/helm/datalayer-jump>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| jump.env.AWS_ACCESS_KEY_ID | string | `""` | |
| jump.env.AWS_DEFAULT_REGION | string | `""` | |
| jump.env.AWS_SECRET_ACCESS_KEY | string | `""` | |
| jump.env.DATALAYER_CDN_URL | string | `""` | |
| jump.env.DATALAYER_JWT_SECRET | string | `""` | |
| jump.env.DATALAYER_KEYCLOAK_REALM_CLIENT_SECRET | string | `""` | |
| jump.env.DATALAYER_KEYCLOAK_SCHEME_HOST | string | `""` | |
| jump.env.DATALAYER_LDAP_BIND | string | `""` | |
| jump.env.DATALAYER_LDAP_BIND_PWD | string | `""` | |
| jump.env.DATALAYER_LDAP_HOST | string | `""` | |
| jump.env.DATALAYER_RUN_HOST | string | `""` | |
| jump.env.DATALAYER_SMTP_HOST | string | `""` | |
| jump.env.DATALAYER_SMTP_PASSWORD | string | `""` | |
| jump.env.DATALAYER_SMTP_PORT | string | `""` | |
| jump.env.DATALAYER_SMTP_USERNAME | string | `""` | |
| jump.env.DATALAYER_SOLR_ZK_HOST | string | `""` | |
| jump.image | string | `"datalayer/jump:0.0.6"` | |
| jump.imagePullPolicy | string | `"IfNotPresent"` | |
| jump.port | int | `2223` | |
| jump.service.name | string | `"jump"` | |
| jump.service.type | string | `"LoadBalancer"` | |
| jump.sidecar.image | string | `"datalayer/whoami:0.0.6"` | |

# Datalayer Jump Helm Chart
43 changes: 41 additions & 2 deletions datalayer-jupyter/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# jupyter

![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![AppVersion: 0.1.1](https://img.shields.io/badge/AppVersion-0.1.1-informational?style=flat-square)

Datalayer Jupyter

**Homepage:** <https://datalayer.io>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Source Code

* <https://github.com/datalayer/services/tree/main/plane/etc/helm/datalayer-jupyter>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| jupyter.certificateIssuer | string | `"letsencrypt"` | |
| jupyter.clusterType | string | `"any"` | |
| jupyter.env.DATALAYER_AUTHZ_ENGINE | string | `""` | |
| jupyter.env.DATALAYER_CDN_URL | string | `""` | |
| jupyter.env.DATALAYER_JWT_ALGORITHM | string | `""` | |
| jupyter.env.DATALAYER_JWT_ISSUER | string | `"https://id.datalayer.run"` | |
| jupyter.env.DATALAYER_JWT_SECRET | string | `""` | |
| jupyter.env.DATALAYER_OPENFGA_AUTHZ_MODEL_ID | string | `""` | |
| jupyter.env.DATALAYER_OPENFGA_REST_URL | string | `"http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"` | |
| jupyter.env.DATALAYER_OPENFGA_STORE_ID | string | `""` | |
| jupyter.env.DATALAYER_OPERATOR_API_KEY | string | `""` | |
| jupyter.env.DATALAYER_RUNTIME_ENV | string | `"prod"` | |
| jupyter.env.DATALAYER_RUN_HOST | string | `""` | |
| jupyter.env.DATALAYER_SOLR_ZK_HOST | string | `"solr-datalayer-solrcloud-zookeeper-headless.datalayer-solr.svc.cluster.local"` | |
| jupyter.image | string | `"datalayer/jupyter:0.1.1"` | |
| jupyter.imagePullPolicy | string | `"Always"` | |
| jupyter.ingressClass | string | `"datalayer-traefik"` | |
| jupyter.port | int | `9500` | |
| jupyter.sidecar.image | string | `"datalayer/whoami:0.0.6"` | |

# Datalayer Jupyter Helm Chart
14 changes: 7 additions & 7 deletions datalayer-jupyter/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ jupyter:
# memory: "8192Mi"
# cpu: "3000m"
env:
DATALAYER_RUN_HOST: ""
DATALAYER_AUTHZ_ENGINE: ""
DATALAYER_CDN_URL: ""
DATALAYER_RUNTIME_ENV: "prod"
DATALAYER_JWT_ISSUER: ""
DATALAYER_JWT_SECRET: ""
DATALAYER_JWT_ALGORITHM: ""
DATALAYER_AUTHZ_ENGINE: ""
DATALAYER_JWT_ISSUER: "https://id.datalayer.run"
DATALAYER_JWT_SECRET: ""
DATALAYER_OPENFGA_AUTHZ_MODEL_ID: ""
DATALAYER_OPENFGA_REST_URL: "http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"
DATALAYER_OPENFGA_STORE_ID: ""
DATALAYER_OPENFGA_AUTHZ_MODEL_ID: ""
DATALAYER_SOLR_ZK_HOST: "solr-datalayer-solrcloud-zookeeper-headless.datalayer-solr.svc.cluster.local"
DATALAYER_OPERATOR_API_KEY: ""
DATALAYER_RUNTIME_ENV: "prod"
DATALAYER_RUN_HOST: ""
DATALAYER_SOLR_ZK_HOST: "solr-datalayer-solrcloud-zookeeper-headless.datalayer-solr.svc.cluster.local"
47 changes: 45 additions & 2 deletions datalayer-library/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# library

![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![AppVersion: 0.0.6](https://img.shields.io/badge/AppVersion-0.0.6-informational?style=flat-square)

Datalayer Library

**Homepage:** <https://datalayer.io>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Source Code

* <https://github.com/datalayer/services/tree/main/plane/etc/helm/datalayer-library>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| library.env.AWS_ACCESS_KEY_ID | string | `""` | |
| library.env.AWS_DEFAULT_REGION | string | `""` | |
| library.env.AWS_SECRET_ACCESS_KEY | string | `""` | |
| library.env.DATALAYER_AUTHZ_ENGINE | string | `""` | |
| library.env.DATALAYER_CDN_URL | string | `""` | |
| library.env.DATALAYER_JWT_ALGORITHM | string | `""` | |
| library.env.DATALAYER_JWT_ISSUER | string | `""` | |
| library.env.DATALAYER_JWT_SECRET | string | `""` | |
| library.env.DATALAYER_OPENFGA_AUTHZ_MODEL_ID | string | `""` | |
| library.env.DATALAYER_OPENFGA_REST_URL | string | `"http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"` | |
| library.env.DATALAYER_OPENFGA_STORE_ID | string | `""` | |
| library.env.DATALAYER_RUN_HOST | string | `""` | |
| library.env.DATALAYER_SMTP_HOST | string | `""` | |
| library.env.DATALAYER_SMTP_PASSWORD | string | `""` | |
| library.env.DATALAYER_SMTP_PORT | string | `""` | |
| library.env.DATALAYER_SMTP_USERNAME | string | `""` | |
| library.env.DATALAYER_SOLR_ZK_HOST | string | `""` | |
| library.image | string | `"datalayer/library:0.0.6"` | |
| library.imagePullPolicy | string | `"IfNotPresent"` | |
| library.port | int | `9800` | |
| library.service.name | string | `"library"` | |
| library.service.type | string | `"LoadBalancer"` | |
| library.sidecar.image | string | `"datalayer/whoami:0.0.6"` | |

# Datalayer Library Helm Chart
42 changes: 40 additions & 2 deletions datalayer-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# operator

![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![AppVersion: 0.1.1](https://img.shields.io/badge/AppVersion-0.1.1-informational?style=flat-square)

Datalayer Operator

**Homepage:** <https://datalayer.io>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Source Code

* <https://github.com/datalayer/services/tree/main/plane/etc/helm/datalayer-operator>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| operator.crds | bool | `true` | |
| operator.env.AWS_ACCESS_KEY_ID | string | `""` | |
| operator.env.AWS_DEFAULT_REGION | string | `""` | |
| operator.env.AWS_SECRET_ACCESS_KEY | string | `""` | |
| operator.env.DATALAYER_AUTHZ_ENGINE | string | `"openfga"` | |
| operator.env.DATALAYER_CERT_ISSUER | string | `"letsencrypt"` | |
| operator.env.DATALAYER_DOCKER_REGISTRY | string | `""` | |
| operator.env.DATALAYER_IAM_API_KEY | string | `""` | |
| operator.env.DATALAYER_IAM_HOST | string | `"datalayer-iam-svc.datalayer-api.svc.cluster.local:9700"` | |
| operator.env.DATALAYER_INGRESS_CLASS_NAME | string | `"datalayer-traefik"` | |
| operator.env.DATALAYER_OPERATOR_API_KEY | string | `""` | |
| operator.env.DATALAYER_PUB_SUB_ENGINE | string | `"pulsar"` | |
| operator.env.DATALAYER_PULSAR_URL | string | `"pulsar://datalayer-pulsar-broker.datalayer-pulsar.svc.cluster.local:6650"` | |
| operator.env.DATALAYER_RUN_HOST | string | `""` | |
| operator.image | string | `"datalayer/operator:0.1.1"` | |
| operator.imagePullPolicy | string | `"Always"` | |
| operator.port | int | `2111` | |
| operator.sidecar.image | string | `"datalayer/whoami:0.0.6"` | |

# Datalayer Operator Helm Chart
6 changes: 4 additions & 2 deletions datalayer-operator/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ operator:
sidecar:
image: datalayer/whoami:0.0.6
imagePullPolicy: Always
crds: false
crds: true
port: 2111
# resources:
# limits:
Expand All @@ -13,11 +13,13 @@ operator:
AWS_ACCESS_KEY_ID: ""
AWS_DEFAULT_REGION: ""
AWS_SECRET_ACCESS_KEY: ""
DATALAYER_AUTHZ_ENGINE: "openfga"
DATALAYER_CERT_ISSUER: "letsencrypt"
DATALAYER_DOCKER_REGISTRY: ""
DATALAYER_IAM_API_KEY: ""
DATALAYER_IAM_HOST: "datalayer-iam-svc.datalayer-api.svc.cluster.local:9700"
DATALAYER_INGRESS_CLASS_NAME: "datalayer-traefik"
DATALAYER_OPERATOR_API_KEY: ""
DATALAYER_RUN_HOST: ""
DATALAYER_PUB_SUB_ENGINE: "pulsar"
DATALAYER_PULSAR_URL: "pulsar://datalayer-pulsar-broker.datalayer-pulsar.svc.cluster.local:6650"
DATALAYER_RUN_HOST: ""
48 changes: 46 additions & 2 deletions datalayer-spacer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,47 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# spacer

![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![AppVersion: 0.0.6](https://img.shields.io/badge/AppVersion-0.0.6-informational?style=flat-square)

Datalayer Spacer

**Homepage:** <https://datalayer.io>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Source Code

* <https://github.com/datalayer/services/tree/main/plane/etc/helm/datalayer-spacer>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| spacer.env.AWS_ACCESS_KEY_ID | string | `""` | |
| spacer.env.AWS_DEFAULT_REGION | string | `""` | |
| spacer.env.AWS_SECRET_ACCESS_KEY | string | `""` | |
| spacer.env.DATALAYER_AUTHZ_ENGINE | string | `""` | |
| spacer.env.DATALAYER_CDN_URL | string | `""` | |
| spacer.env.DATALAYER_JWT_ALGORITHM | string | `""` | |
| spacer.env.DATALAYER_JWT_ISSUER | string | `""` | |
| spacer.env.DATALAYER_JWT_SECRET | string | `""` | |
| spacer.env.DATALAYER_OPENFGA_AUTHZ_MODEL_ID | string | `""` | |
| spacer.env.DATALAYER_OPENFGA_REST_URL | string | `"http://datalayer-openfga.datalayer-openfga.svc.cluster.local:8080"` | |
| spacer.env.DATALAYER_OPENFGA_STORE_ID | string | `""` | |
| spacer.env.DATALAYER_RUNTIME_ENV | string | `"prod"` | |
| spacer.env.DATALAYER_RUN_HOST | string | `""` | |
| spacer.env.DATALAYER_SMTP_HOST | string | `""` | |
| spacer.env.DATALAYER_SMTP_PASSWORD | string | `""` | |
| spacer.env.DATALAYER_SMTP_PORT | string | `""` | |
| spacer.env.DATALAYER_SMTP_USERNAME | string | `""` | |
| spacer.env.DATALAYER_SOLR_ZK_HOST | string | `""` | |
| spacer.image | string | `"datalayer/spacer:0.0.6"` | |
| spacer.imagePullPolicy | string | `"IfNotPresent"` | |
| spacer.port | int | `9900` | |
| spacer.service.name | string | `"spacer"` | |
| spacer.service.type | string | `"LoadBalancer"` | |
| spacer.sidecar.image | string | `"datalayer/whoami:0.0.6"` | |

# Datalayer Spacer Helm Chart
28 changes: 26 additions & 2 deletions example-simple/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)
# datalayer-simple

![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![AppVersion: 0.0.6](https://img.shields.io/badge/AppVersion-0.0.6-informational?style=flat-square)

Datalaeyr Simple Helm Chart Example

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Datalayer | <[email protected]> | |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| api.address | string | `"simple-address"` | |
| api.password | string | `"simple_password"` | |
| api.secretName | string | `"simple-secret"` | |
| api.secretNamespace | string | `"simple"` | |
| api.username | string | `"datalayer"` | |
| namespace | string | `"datalayer-simple"` | |
| service.name | string | `"simple-svc"` | |
| service.type | string | `"NodePort"` | |
| simple.image | string | `"datalayer/example-simple:0.0.6"` | |
| simpleSecretName | string | `"simple-secret"` | |

# Datalayer Example Simple Helm Chart
Loading

0 comments on commit 92d3826

Please sign in to comment.