From 72b340e170418a4b8cd35c320f59eb7219c2166e Mon Sep 17 00:00:00 2001 From: petruki <31597636+petruki@users.noreply.github.com> Date: Sat, 19 Jul 2025 16:13:44 -0700 Subject: [PATCH] Updated Charts Docs, adding provenance --- .github/workflows/release.yml | 17 +- README.md | 240 +++------------------------ charts/switcher-api/Chart.yaml | 2 +- charts/switcher-api/README.md | 111 +++++++++++++ charts/switcher-gitops/Chart.yaml | 2 +- charts/switcher-gitops/README.md | 51 ++++++ charts/switcher-slack-app/Chart.yaml | 2 +- charts/switcher-slack-app/README.md | 58 +++++++ cr.yaml | 2 + 9 files changed, 264 insertions(+), 221 deletions(-) create mode 100644 charts/switcher-api/README.md create mode 100644 charts/switcher-gitops/README.md create mode 100644 charts/switcher-slack-app/README.md create mode 100644 cr.yaml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 32fa542..3229c49 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -8,7 +8,6 @@ on: jobs: release: runs-on: ubuntu-latest - if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')" steps: - name: Checkout @@ -21,7 +20,23 @@ jobs: git config user.name "$GITHUB_ACTOR" git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + - name: Prepare GPG key + run: | + gpg_dir=.cr-gpg + mkdir "$gpg_dir" + keyring="$gpg_dir/secring.gpg" + base64 -d <<< "$GPG_KEYRING_BASE64" > "$keyring" + passphrase_file="$gpg_dir/passphrase" + echo "$GPG_PASSPHRASE" > "$passphrase_file" + echo "CR_PASSPHRASE_FILE=$passphrase_file" >> "$GITHUB_ENV" + echo "CR_KEYRING=$keyring" >> "$GITHUB_ENV" + env: + GPG_KEYRING_BASE64: "${{ secrets.GPG_KEYRING_BASE64 }}" + GPG_PASSPHRASE: "${{ secrets.GPG_PASSPHRASE }}" + - name: Run chart-releaser uses: helm/chart-releaser-action@v1.7.0 + with: + config: cr.yaml env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" \ No newline at end of file diff --git a/README.md b/README.md index 481ef1e..de7d722 100644 --- a/README.md +++ b/README.md @@ -1,248 +1,54 @@ ***
-Switcher API Kubernetes Helm Charts +Switcher API Helm Charts
[![Release Charts](https://github.com/switcherapi/helm-charts/actions/workflows/release.yml/badge.svg)](https://github.com/switcherapi/helm-charts/actions/workflows/release.yml) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/switcherapi)](https://artifacthub.io/packages/search?repo=switcherapi) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/switcherapi/helm-charts/blob/main/LICENSE) [![Slack: Switcher-HQ](https://img.shields.io/badge/slack-@switcher/hq-blue.svg?logo=slack)](https://switcher-hq.slack.com/)
*** -# Table of Contents - -- [Switcher API Helm Charts](#switcher-api-helm-charts) -- [Switcher Slack App Helm Charts](#switcher-slack-app-helm-charts) -- [Switcher GitOps Helm Charts](#switcher-gitops-helm-charts) - -# Switcher API Helm Charts - -Deploy Switcher API using `switcherapi/switcher-api` Helm Charts. - -## Usage +Switcher API Helm Charts provide a set of Helm charts for deploying the Switcher API and its related components in Kubernetes environments. These charts simplify the deployment and management of the Switcher API ecosystem, including the core API, resolver node, management interface, Slack app integration, and GitOps orchestrator. [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. -Once Helm is set up properly, follow the steps below: - -> Install MongoDB -```console -helm repo add bitnami https://charts.bitnami.com/bitnami -helm install db bitnami/mongodb \ - --namespace=switcherapi --create-namespace \ - --set auth.enabled=false -``` - -> Install Switcher API -```console +```bash helm repo add switcherapi https://switcherapi.github.io/helm-charts -helm install switcherapi switcherapi/switcher-api \ - --namespace=switcherapi --create-namespace ``` -> Uninstall Switcher API -```console -helm uninstall switcherapi --namespace switcherapi -``` +# Switcher API Helm Charts -### API parameters - -| Name | Description | Value | -| -------------------------- | ---------------------------------------------- | ---------------------- | -| `api.image.tag` | Switcher API Image tag | `latest` | -| `api.service.port` | API Service port | 3000 | - -| Name | Description | Value | -| ------------------------------------- | --------------------------------------------- | --------------------- | -| `api.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | -| `api.env.resourceSecret` | API Swagger (user: admin) | `admin` | -| `api.env.switcherApiLogger` | API log | true | -| `api.env.historyActivated` | API Change Log record | true | -| `api.env.permissionCacheActivated` | API Permission Cache | true | -| `api.env.googleSkipAuth` | Skip Google ReCaptcha validation | true | -| `api.env.metricsMaxPage` | Metrics: max logs per page | 50 | -| `api.env.strategyMaxOperation` | Strategy: max operation entries | 100 | -| `api.env.relayBypassHttps` | Relay: Bypass HTTPS validation | false | -| `api.env.relayBypassVerification` | Relay: Bypass Verification | false | -| `api.env.maxRequestPerMinute` | API max Request per minute | 1000 | -| `api.env.jwtAdminTokenRenewInterval` | User token renew interval | `5m` | -| `api.env.mongoUri` | API Database URI | < see values.yml > | -| `api.env.bitbucketClientId` | Bitbucket Client Id | `` | -| `api.env.bitbucketClientSecret` | Bitbucket Client Secret | `` | -| `api.env.githubClientId` | GitHub Client Id | `` | -| `api.env.githubClientSecret` | GitHub Client Secret | `` | -| `api.env.googleRecaptchaSecret` | Google ReCaptcha Secret | `` | -| `api.env.switcherSlackJwtSecret` | Switcher Slack Secret | `` | -| `api.env.switcherGitOpsJwtSecret` | Switcher GitOps Secret | `` | -| `api.env.switcherGitOpsUrl` | Switcher GitOps URL | `` | - -### Resolver API parameters - -| Name | Description | Value | -| ------------------------------- | ---------------------------------------------- | ---------------------- | -| `resolver.image.tag` | Switcher Resolver Image tag | `latest` | -| `resolver.service.port` | API Service port | 3001 | - -| Name | Description | Value | -| ------------------------------------------ | --------------------------------------------- | --------------------- | -| `resolver.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | -| `resolver.env.resourceSecret` | API Swagger (user: admin) | `admin` | -| `resolver.env.switcherApiLogger` | API log | true | -| `resolver.env.metricsActivated` | API Metrics record | true | -| `resolver.env.relayBypassHttps` | Relay: Bypass HTTPS validation | false | -| `resolver.env.relayBypassVerification` | Relay: Bypass Verification | false | -| `resolver.env.regexMaxTimeout` | Regex Validator: max timeout in ms | 3000 | -| `resolver.env.regexMaxBlacklist` | Regex Validator: max blacklist entries | 50 | -| `resolver.env.maxRequestPerMinute` | API max Request per minute | 0 (unlimited) | -| `resolver.env.jwtClientTokenExpTime` | Component token renew interval | `5m` | -| `resolver.env.mongoUri` | API Database URI | < see values.yml > | - -### Management parameters - -| Name | Description | Value | -| -------------------------- | ---------------------------------------------- | ---------------------- | -| `management.image.tag` | Switcher Management Image tag | `latest` | -| `management.service.port` | Management Service port | 8080 | - -| Name | Description | Value | -| ------------------------------------- | ---------------------------------------------- | ------------------------- | -| `management.env.switcherApiUrl` | Switcher API URL | `http://localhost:3000` | -| `management.env.switcherManagementUrl`| Management callback URL | `http://localhost:8080` | -| `management.env.switcherSlackUrl` | Switcher Slack App URL | `http://localhost:5000` | -| `management.env.allowHomeView` | Allow Home View | false | -| `management.env.googleRecaptcha` | Google ReCaptcha Public Key | `` | -| `management.env.bitbucketClientId` | Bitbucket Client Id | `` | -| `management.env.githubClientId` | GitHub Client Id | `` | - -## Local - -Validate Chart from local Values -```console -helm install -f charts/switcher-api/values.yaml switcherapi ./charts/switcher-api/ \ - --namespace=switcherapi --create-namespace -``` +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/switcher-api)](https://artifacthub.io/packages/helm/switcherapi/switcher-api) +[![Charts README](https://img.shields.io/badge/charts-README-blue.svg)](https://github.com/switcherapi/helm-charts/blob/master/charts/switcher-api/README.md) -SSL Enabled -```console -helm install -f charts/switcher-api/values.yaml switcherapi ./charts/switcher-api/ \ - --namespace=switcherapi --create-namespace \ - --set api.env.sslSecretName="[CHANGE_ME]" \ - --set management.env.switcherApiUrl="https://localhost:3000" \ - --set management.env.switcherManagementUrl="https://localhost:8080" -``` +| Component | Description | Repository Link | Source Code | +|-----------|-------------|-----------------|-------------| +| Switcher API | Core API that manages Switcher API ecosystem | [Docker Hub](https://hub.docker.com/r/trackerforce/switcher-api) | [GitHub](https://github.com/switcherapi/switcher-api) | +| Switcher Resolver Node | Proxy handler that interfaces Switcher Components with Switcher API | [Docker Hub](https://hub.docker.com/r/trackerforce/switcher-resolver-node) | [GitHub](https://github.com/switcherapi/switcher-resolver-node) | +| Switcher Management | Web interface for managing Switcher API | [Docker Hub](https://hub.docker.com/r/trackerforce/switcher-management) | [GitHub](https://github.com/switcherapi/switcher-management) | # Switcher Slack App Helm Charts -Deploy Switcher Slack App using `switcherapi/switcher-slack-app` Helm Charts. - -## Usage +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/switcher-slack-app)](https://artifacthub.io/packages/helm/switcherapi/switcher-slack-app) +[![Charts README](https://img.shields.io/badge/charts-README-blue.svg)](https://github.com/switcherapi/helm-charts/blob/master/charts/switcher-slack-app/README.md) -Follow the [Switcher Slack App instructions](https://github.com/switcherapi/switcher-slack-app#create-slack-app) to create a Slack App before installing this Chart. - -> Install Switcher Slack App -```console -helm repo add switcherapi https://switcherapi.github.io/helm-charts -helm install switcherslackapp switcherapi/switcher-slack-app \ - --namespace=switcherapi --create-namespace \ - --set app.env.slackClientId="" \ - --set app.env.switcherManagementUrl="" \ - --set app.env.switcherAPIUrl="" \ - --set app.env.switcherJwtSecret="" \ - --set app.env.slackSigningSecret="" \ - --set app.env.slackClientSecret="" -``` - -> Uninstall Switcher Slack App -```console -helm uninstall switcherslackapp --namespace switcherapi -``` - -### App parameters - -| Name | Description | Value | -| -------------------------- | ---------------------------------------------- | ---------------------- | -| `app.image.tag` | Switcher Slack App Image tag | `latest` | -| `app.service.port` | App Service port | 5000 | - -| Name | Description | Value | -| --------------------------------- | ---------------------------------------------- | ---------------------- | -| `app.env.slackClientId` | Slack Client Id | `` | -| `app.env.switcherManagementUrl` | Switcher Management URL for callback auth | `` | -| `app.env.switcherAPIUrl` | Switcher API URL | `` | -| `app.env.switcherCertPath` | Switcher API SSL Cert Path | `` | -| `app.env.switcherJwtSecret` | Switcher API JWT Secret | `` | -| `app.env.slackSigningSecret` | Slack Signing Secret | `` | -| `app.env.slackClientSecret` | Slack Client Secret | `` | -| `app.env.sslSecretName` | SSL Secret Name (TLS for Switcher API) | `` | - -## Local - -Validate Chart from local Values -```console -helm install -f charts/switcher-slack-app/values.yaml switcherslackapp ./charts/switcher-slack-app/ \ - --namespace=switcherapi --create-namespace \ - --set app.env.slackClientId="[CHANGE_ME]" \ - --set app.env.switcherManagementUrl="https://cloud.switcherapi.com" \ - --set app.env.switcherAPIUrl="https://switcherapi.com/api" \ - --set app.env.switcherJwtSecret="[CHANGE_ME]" \ - --set app.env.slackSigningSecret="[CHANGE_ME]" \ - --set app.env.slackClientSecret="[CHANGE_ME]" -``` +| Component | Description | Repository Link | Source Code | +|-----------|-------------|-----------------|-------------| +| Switcher Slack App | Allows teams to integrate Switcher API workflows with Slack | [Docker Hub](https://hub.docker.com/r/trackerforce/switcher-slack-app) | [GitHub](https://github.com/switcherapi/switcher-slack-app) | # Switcher GitOps Helm Charts -Deploy Switcher GitOps using `switcherapi/switcher-gitops` Helm Charts. - -## Usage - -> Install Switcher GitOps -```console -helm repo add switcherapi https://switcherapi.github.io/helm-charts -helm install switchergitops switcherapi/switcher-gitops \ - --namespace=switcherapi --create-namespace \ - --set app.env.switcherAPIUrl="" \ - --set app.env.switcherApiJwtSecret="" \ - --set app.env.gitTokenPrivateKey="" -``` - -> Uninstall Switcher GitOps -```console -helm uninstall switchergitops --namespace switcherapi -``` +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/switcher-gitops)](https://artifacthub.io/packages/helm/switcherapi/switcher-gitops) +[![Charts README](https://img.shields.io/badge/charts-README-blue.svg)](https://github.com/switcherapi/helm-charts/blob/master/charts/switcher-gitops/README.md) -### App parameters - -| Name | Description | Value | -| -------------------------- | ---------------------------------------------- | ---------------------- | -| `app.image.tag` | Switcher GitOps Image tag | `latest` | -| `app.service.port` | App Service port | 8000 | - -| Name | Description | Value | -| --------------------------------- | ---------------------------------------------- | ---------------------- | -| `api.env.sslEnabled` | API SSL Enabled | `false` | -| `api.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | -| `app.env.switcherCertPath` | API SSL Cert Path | `` | -| `app.env.gitTokenPrivateKey` | Git Token Private Key | `` | -| `app.env.switcherApiJwtSecret` | Switcher API JWT Secret | `` | -| `app.env.switcherAPIUrl` | Switcher API URL | `` | -| `app.env.switcherApiCACert` | Switcher API SSL CA Cert Path | `` | -| `app.env.mongoUri` | API Database URI | < see values.yml > | -| `app.env.mongoDb` | API Database Name | `switcher-gitops` | -| `app.env.hanlderWaitingTime` | Handler Waiting Time | `1m` | -| `app.env.gitUser` | Git User | `switcher-gitops` | - -## Local - -Validate Chart from local Values -```console -helm install -f charts/switcher-gitops/values.yaml switchergitops ./charts/switcher-gitops/ \ - --namespace=switcherapi --create-namespace \ - --set app.env.switcherApiJwtSecret="[CHANGE_ME]" \ - --set app.env.gitTokenPrivateKey="[CHANGE_ME]" -``` \ No newline at end of file +| Component | Description | Repository Link | Source Code | +|-----------|-------------|-----------------|-------------| +| Switcher GitOps | GitOps Domain Snapshot Orchestrator | [Docker Hub](https://hub.docker.com/r/trackerforce/switcher-gitops) | [GitHub](https://github.com/switcherapi/switcher-gitops) | \ No newline at end of file diff --git a/charts/switcher-api/Chart.yaml b/charts/switcher-api/Chart.yaml index 3b63ded..de820f6 100644 --- a/charts/switcher-api/Chart.yaml +++ b/charts/switcher-api/Chart.yaml @@ -9,5 +9,5 @@ maintainers: url: https://github.com/petruki type: application -version: 1.3.2 +version: 1.3.3 appVersion: "latest" diff --git a/charts/switcher-api/README.md b/charts/switcher-api/README.md new file mode 100644 index 0000000..2da762a --- /dev/null +++ b/charts/switcher-api/README.md @@ -0,0 +1,111 @@ +# Switcher API Helm Charts + +Deploy Switcher API using `switcherapi/switcher-api` Helm Charts. + +## Usage + +> Install MongoDB (optional) +```console +helm repo add bitnami https://charts.bitnami.com/bitnami +helm install db bitnami/mongodb \ + --namespace=switcherapi --create-namespace \ + --set auth.enabled=false +``` + +> Install Switcher API +```console +helm repo add switcherapi https://switcherapi.github.io/helm-charts +helm install switcherapi switcherapi/switcher-api \ + --namespace=switcherapi --create-namespace +``` + +> Uninstall Switcher API +```console +helm uninstall switcherapi --namespace switcherapi +``` + +### API parameters + +| Name | Description | Value | +| -------------------------- | ---------------------------------------------- | ---------------------- | +| `api.image.tag` | Switcher API Image tag | `latest` | +| `api.service.port` | API Service port | 3000 | + +| Name | Description | Value | +| ------------------------------------- | --------------------------------------------- | --------------------- | +| `api.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | +| `api.env.resourceSecret` | API Swagger (user: admin) | `admin` | +| `api.env.switcherApiLogger` | API log | true | +| `api.env.historyActivated` | API Change Log record | true | +| `api.env.permissionCacheActivated` | API Permission Cache | true | +| `api.env.googleSkipAuth` | Skip Google ReCaptcha validation | true | +| `api.env.metricsMaxPage` | Metrics: max logs per page | 50 | +| `api.env.strategyMaxOperation` | Strategy: max operation entries | 100 | +| `api.env.relayBypassHttps` | Relay: Bypass HTTPS validation | false | +| `api.env.relayBypassVerification` | Relay: Bypass Verification | false | +| `api.env.maxRequestPerMinute` | API max Request per minute | 1000 | +| `api.env.jwtAdminTokenRenewInterval` | User token renew interval | `5m` | +| `api.env.mongoUri` | API Database URI | < see values.yml > | +| `api.env.bitbucketClientId` | Bitbucket Client Id | `` | +| `api.env.bitbucketClientSecret` | Bitbucket Client Secret | `` | +| `api.env.githubClientId` | GitHub Client Id | `` | +| `api.env.githubClientSecret` | GitHub Client Secret | `` | +| `api.env.googleRecaptchaSecret` | Google ReCaptcha Secret | `` | +| `api.env.switcherSlackJwtSecret` | Switcher Slack Secret | `` | +| `api.env.switcherGitOpsJwtSecret` | Switcher GitOps Secret | `` | +| `api.env.switcherGitOpsUrl` | Switcher GitOps URL | `` | + +### Resolver API parameters + +| Name | Description | Value | +| ------------------------------- | ---------------------------------------------- | ---------------------- | +| `resolver.image.tag` | Switcher Resolver Image tag | `latest` | +| `resolver.service.port` | API Service port | 3001 | + +| Name | Description | Value | +| ------------------------------------------ | --------------------------------------------- | --------------------- | +| `resolver.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | +| `resolver.env.resourceSecret` | API Swagger (user: admin) | `admin` | +| `resolver.env.switcherApiLogger` | API log | true | +| `resolver.env.metricsActivated` | API Metrics record | true | +| `resolver.env.relayBypassHttps` | Relay: Bypass HTTPS validation | false | +| `resolver.env.relayBypassVerification` | Relay: Bypass Verification | false | +| `resolver.env.regexMaxTimeout` | Regex Validator: max timeout in ms | 3000 | +| `resolver.env.regexMaxBlacklist` | Regex Validator: max blacklist entries | 50 | +| `resolver.env.maxRequestPerMinute` | API max Request per minute | 0 (unlimited) | +| `resolver.env.jwtClientTokenExpTime` | Component token renew interval | `5m` | +| `resolver.env.mongoUri` | API Database URI | < see values.yml > | + +### Management parameters + +| Name | Description | Value | +| -------------------------- | ---------------------------------------------- | ---------------------- | +| `management.image.tag` | Switcher Management Image tag | `latest` | +| `management.service.port` | Management Service port | 8080 | + +| Name | Description | Value | +| ------------------------------------- | ---------------------------------------------- | ------------------------- | +| `management.env.switcherApiUrl` | Switcher API URL | `http://localhost:3000` | +| `management.env.switcherManagementUrl`| Management callback URL | `http://localhost:8080` | +| `management.env.switcherSlackUrl` | Switcher Slack App URL | `http://localhost:5000` | +| `management.env.allowHomeView` | Allow Home View | false | +| `management.env.googleRecaptcha` | Google ReCaptcha Public Key | `` | +| `management.env.bitbucketClientId` | Bitbucket Client Id | `` | +| `management.env.githubClientId` | GitHub Client Id | `` | + +## Local + +Validate Chart from local Values +```console +helm install -f charts/switcher-api/values.yaml switcherapi ./charts/switcher-api/ \ + --namespace=switcherapi --create-namespace +``` + +SSL Enabled +```console +helm install -f charts/switcher-api/values.yaml switcherapi ./charts/switcher-api/ \ + --namespace=switcherapi --create-namespace \ + --set api.env.sslSecretName="[CHANGE_ME]" \ + --set management.env.switcherApiUrl="https://localhost:3000" \ + --set management.env.switcherManagementUrl="https://localhost:8080" +``` \ No newline at end of file diff --git a/charts/switcher-gitops/Chart.yaml b/charts/switcher-gitops/Chart.yaml index 2ff5818..f7f9cb1 100644 --- a/charts/switcher-gitops/Chart.yaml +++ b/charts/switcher-gitops/Chart.yaml @@ -9,5 +9,5 @@ maintainers: url: https://github.com/petruki type: application -version: 1.0.0 +version: 1.0.1 appVersion: "latest" diff --git a/charts/switcher-gitops/README.md b/charts/switcher-gitops/README.md new file mode 100644 index 0000000..afec287 --- /dev/null +++ b/charts/switcher-gitops/README.md @@ -0,0 +1,51 @@ +# Switcher GitOps Helm Charts + +Deploy Switcher GitOps using `switcherapi/switcher-gitops` Helm Charts. + +## Usage + +> Install Switcher GitOps +```console +helm repo add switcherapi https://switcherapi.github.io/helm-charts +helm install switchergitops switcherapi/switcher-gitops \ + --namespace=switcherapi --create-namespace \ + --set app.env.switcherAPIUrl="" \ + --set app.env.switcherApiJwtSecret="" \ + --set app.env.gitTokenPrivateKey="" +``` + +> Uninstall Switcher GitOps +```console +helm uninstall switchergitops --namespace switcherapi +``` + +### App parameters + +| Name | Description | Value | +| -------------------------- | ---------------------------------------------- | ---------------------- | +| `app.image.tag` | Switcher GitOps Image tag | `latest` | +| `app.service.port` | App Service port | 8000 | + +| Name | Description | Value | +| --------------------------------- | ---------------------------------------------- | ---------------------- | +| `api.env.sslEnabled` | API SSL Enabled | `false` | +| `api.env.sslSecretName` | API SSL Secret Name (enable HTTPS) | `` | +| `app.env.switcherCertPath` | API SSL Cert Path | `` | +| `app.env.gitTokenPrivateKey` | Git Token Private Key | `` | +| `app.env.switcherApiJwtSecret` | Switcher API JWT Secret | `` | +| `app.env.switcherAPIUrl` | Switcher API URL | `` | +| `app.env.switcherApiCACert` | Switcher API SSL CA Cert Path | `` | +| `app.env.mongoUri` | API Database URI | < see values.yml > | +| `app.env.mongoDb` | API Database Name | `switcher-gitops` | +| `app.env.hanlderWaitingTime` | Handler Waiting Time | `1m` | +| `app.env.gitUser` | Git User | `switcher-gitops` | + +## Local + +Validate Chart from local Values +```console +helm install -f charts/switcher-gitops/values.yaml switchergitops ./charts/switcher-gitops/ \ + --namespace=switcherapi --create-namespace \ + --set app.env.switcherApiJwtSecret="[CHANGE_ME]" \ + --set app.env.gitTokenPrivateKey="[CHANGE_ME]" +``` \ No newline at end of file diff --git a/charts/switcher-slack-app/Chart.yaml b/charts/switcher-slack-app/Chart.yaml index 13d9bef..a3a4add 100644 --- a/charts/switcher-slack-app/Chart.yaml +++ b/charts/switcher-slack-app/Chart.yaml @@ -9,5 +9,5 @@ maintainers: url: https://github.com/petruki type: application -version: 1.1.2 +version: 1.1.3 appVersion: "latest" diff --git a/charts/switcher-slack-app/README.md b/charts/switcher-slack-app/README.md new file mode 100644 index 0000000..7d2b9d8 --- /dev/null +++ b/charts/switcher-slack-app/README.md @@ -0,0 +1,58 @@ + +# Switcher Slack App Helm Charts + +Deploy Switcher Slack App using `switcherapi/switcher-slack-app` Helm Charts. + +## Usage + +Follow the [Switcher Slack App instructions](https://github.com/switcherapi/switcher-slack-app#create-slack-app) to create a Slack App before installing this Chart. + +> Install Switcher Slack App +```console +helm repo add switcherapi https://switcherapi.github.io/helm-charts +helm install switcherslackapp switcherapi/switcher-slack-app \ + --namespace=switcherapi --create-namespace \ + --set app.env.slackClientId="" \ + --set app.env.switcherManagementUrl="" \ + --set app.env.switcherAPIUrl="" \ + --set app.env.switcherJwtSecret="" \ + --set app.env.slackSigningSecret="" \ + --set app.env.slackClientSecret="" +``` + +> Uninstall Switcher Slack App +```console +helm uninstall switcherslackapp --namespace switcherapi +``` + +### App parameters + +| Name | Description | Value | +| -------------------------- | ---------------------------------------------- | ---------------------- | +| `app.image.tag` | Switcher Slack App Image tag | `latest` | +| `app.service.port` | App Service port | 5000 | + +| Name | Description | Value | +| --------------------------------- | ---------------------------------------------- | ---------------------- | +| `app.env.slackClientId` | Slack Client Id | `` | +| `app.env.switcherManagementUrl` | Switcher Management URL for callback auth | `` | +| `app.env.switcherAPIUrl` | Switcher API URL | `` | +| `app.env.switcherCertPath` | Switcher API SSL Cert Path | `` | +| `app.env.switcherJwtSecret` | Switcher API JWT Secret | `` | +| `app.env.slackSigningSecret` | Slack Signing Secret | `` | +| `app.env.slackClientSecret` | Slack Client Secret | `` | +| `app.env.sslSecretName` | SSL Secret Name (TLS for Switcher API) | `` | + +## Local + +Validate Chart from local Values +```console +helm install -f charts/switcher-slack-app/values.yaml switcherslackapp ./charts/switcher-slack-app/ \ + --namespace=switcherapi --create-namespace \ + --set app.env.slackClientId="[CHANGE_ME]" \ + --set app.env.switcherManagementUrl="https://cloud.switcherapi.com" \ + --set app.env.switcherAPIUrl="https://switcherapi.com/api" \ + --set app.env.switcherJwtSecret="[CHANGE_ME]" \ + --set app.env.slackSigningSecret="[CHANGE_ME]" \ + --set app.env.slackClientSecret="[CHANGE_ME]" +``` \ No newline at end of file diff --git a/cr.yaml b/cr.yaml new file mode 100644 index 0000000..f698d74 --- /dev/null +++ b/cr.yaml @@ -0,0 +1,2 @@ +sign: true +key: roger.petruki@gmail.com \ No newline at end of file