Skip to content

Commit

Permalink
remove/reword remaining references to private docker registries (#4900)
Browse files Browse the repository at this point in the history
  • Loading branch information
conceptualshark authored Jan 24, 2025
1 parent 0d8ce3c commit 080d51b
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 66 deletions.
3 changes: 3 additions & 0 deletions docs/self-managed/setup/deploy/other/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ We provide Docker images [via Dockerhub](https://hub.docker.com/u/camunda). All
The provided Docker images are supported for production usage only on Linux systems. Windows or macOS are only supported for development environments.
:::

## Component images

| Component | Docker image | Link to configuration options |
| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Zeebe | [camunda/zeebe:latest](https://hub.docker.com/r/camunda/zeebe) | [Environment variables](/self-managed/zeebe-deployment/configuration/environment-variables.md) |
Expand All @@ -25,6 +27,7 @@ The provided Docker images are supported for production usage only on Linux syst
| Connectors | [camunda/connectors:latest](https://hub.docker.com/r/camunda/connectors) | [Connectors configuration](/self-managed/connectors-deployment/connectors-configuration.md) |
| Connectors Bundle | [camunda/connectors-bundle:latest](https://hub.docker.com/r/camunda/connectors-bundle) | [Connectors configuration](/self-managed/connectors-deployment/connectors-configuration.md) |
| Web Modeler (restapi, webapp, websockets) | [camunda/web-modeler-restapi:latest](https://hub.docker.com/r/camunda/web-modeler-restapi), [camunda/web-modeler-webapp:latest](https://hub.docker.com/r/camunda/web-modeler-webapp), [camunda/web-modeler-websockets:latest](https://hub.docker.com/r/camunda/web-modeler-websockets) | [Configuration variables](/self-managed/modeler/web-modeler/configuration/configuration.md) |
| Console | [camunda/console:latest](https://hub.docker.com/r/camunda/console) | [Configuration variables](/self-managed/console-deployment/configuration/configuration.md) |

Zeebe is the only component that is often run on its own as a standalone component. In this scenario, it does not need anything else, so a simple `docker run` is sufficient:

Expand Down
4 changes: 2 additions & 2 deletions docs/self-managed/setup/guides/air-gapped-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ The following images must be available in your air-gapped environment:
- [bitnami/os-shell](https://hub.docker.com/r/bitnami/os-shell/)
- [bitnami/elasticsearch](https://hub.docker.com/r/bitnami/elasticsearch/)
- [bitnami/kibana](https://hub.docker.com/r/bitnami/kibana/)
- Web Modeler images (only available from [Camunda's private registry](/self-managed/setup/deploy/other/docker.md#web-modeler)):
- [Web Modeler images](/self-managed/setup/deploy/other/docker.md#component-images):
- `web-modeler-ee/modeler-restapi`
- `web-modeler-ee/modeler-webapp`
- `web-modeler-ee/modeler-websockets`
- Console images (only available from [Camunda's private registry](https://registry.camunda.cloud/)):
- [Console images](/self-managed/setup/deploy/other/docker.md#component-images):
- `console/console-sm`

We currently have a script in the [camunda-helm-respository](https://github.com/camunda/camunda-platform-helm/blob/c6a6e0c327f2acb8746802fbe03b3774b8284de3/scripts/download-chart-docker-images.sh) that will assist in pulling and saving Docker images.
Expand Down
33 changes: 2 additions & 31 deletions docs/self-managed/setup/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,29 +282,6 @@ Camunda 8 components without a valid license may display **Non-Production Licens

## Configuring Web Modeler, Console, and Connectors

### Web Modeler and Console secrets

The Console and Web Modeler Components are published in Camunda's private Docker registry (registry.camunda.cloud) and are under a [proprietary license](/reference/licenses.md#web-modeler-and-console). These components are not available in public repositories.

To enable Kubernetes to pull the images from this registry, first [create an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) using the credentials you received from Camunda:

```shell
kubectl create secret docker-registry registry-camunda-cloud \
--namespace=<NAMESPACE> \
--docker-server=registry.camunda.cloud \
--docker-username=<DOCKER_USER> \
--docker-password=<DOCKER_PASSWORD> \
--docker-email=<DOCKER_EMAIL>
```

:::note
Use `registry-camunda-cloud` as a secret after replacing `<DOCKER_USER>`, `<DOCKER_PASSWORD>`, and `<DOCKER_EMAIL>` with your credentials.

The secret must be created in the same Kubernetes namespace where you'll install the Helm chart. Replace `<NAMESPACE>` to set the namespace.
:::

Alternatively, create an image pull secret [from your Docker configuration file](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials).

### Install Connectors

The **Connector runtime** comes enabled by default. To start using Connectors, install Connector element templates. Learn more in our documentation for [Web Modeler](/components/connectors/manage-connector-templates.md) or [Desktop Modeler](/components/modeler/desktop-modeler/element-templates/configuring-templates.md).
Expand Down Expand Up @@ -376,19 +353,13 @@ For more details, check [Web Modeler Helm values](https://artifacthub.io/package

### Install Console

Console Self-Managed is disabled by default in the Camunda 8 Helm chart, as it requires a [proprietary license](/reference/licenses.md#web-modeler-and-console) to access the Camunda container registry.

To install Console, two steps are required:
Console Self-Managed is disabled by default in the Camunda 8 Helm chart.

1. [Create a secret with Camunda registry credentials](#web-modeler-and-console-secrets).
2. Enable Console, and reference the created Kubernetes secret object via Helm values.
To install Console, enable Console in the Helm chart with `console.enabled: true`. We recommend specifying these values in a YAML file that you pass to the `helm install` command:

```yaml
console:
enabled: true
image:
pullSecrets:
- name: registry-camunda-cloud
```

For more details, check [Console Helm values](https://artifacthub.io/packages/helm/camunda/camunda-platform#console-parameters).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ We provide Docker images [via Dockerhub](https://hub.docker.com/u/camunda). All
The provided Docker images are supported for production usage only on Linux systems. Windows or macOS are only supported for development environments.
:::

## Component images

| Component | Docker image | Link to configuration options |
| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Zeebe | [camunda/zeebe:latest](https://hub.docker.com/r/camunda/zeebe) | [Environment variables](/self-managed/zeebe-deployment/configuration/environment-variables.md) |
Expand All @@ -25,6 +27,7 @@ The provided Docker images are supported for production usage only on Linux syst
| Connectors | [camunda/connectors:latest](https://hub.docker.com/r/camunda/connectors) | [Connectors configuration](/self-managed/connectors-deployment/connectors-configuration.md) |
| Connectors Bundle | [camunda/connectors-bundle:latest](https://hub.docker.com/r/camunda/connectors-bundle) | [Connectors configuration](/self-managed/connectors-deployment/connectors-configuration.md) |
| Web Modeler (restapi, webapp, websockets) | [camunda/web-modeler-restapi:latest](https://hub.docker.com/r/camunda/web-modeler-restapi), [camunda/web-modeler-webapp:latest](https://hub.docker.com/r/camunda/web-modeler-webapp), [camunda/web-modeler-websockets:latest](https://hub.docker.com/r/camunda/web-modeler-websockets) | [Configuration variables](/self-managed/modeler/web-modeler/configuration/configuration.md) |
| Console | [camunda/console:latest](https://hub.docker.com/r/camunda/console) | [Configuration variables](/self-managed/console-deployment/configuration.md) |

Zeebe is the only component that is often run on its own as a standalone component. In this scenario, it does not need anything else, so a simple `docker run` is sufficient:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ The following images must be available in your air-gapped environment:
- [bitnami/os-shell](https://hub.docker.com/r/bitnami/os-shell/)
- [bitnami/elasticsearch](https://hub.docker.com/r/bitnami/elasticsearch/)
- [bitnami/kibana](https://hub.docker.com/r/bitnami/kibana/)
- Web Modeler images (only available from [Camunda's private registry](/self-managed/setup/deploy/other/docker.md#web-modeler)):
- [Web Modeler images](/self-managed/setup/deploy/other/docker.md#component-images):
- `web-modeler-ee/modeler-restapi`
- `web-modeler-ee/modeler-webapp`
- `web-modeler-ee/modeler-websockets`
- Console images (only available from [Camunda's private registry](https://registry.camunda.cloud/)):
- [Console images](/self-managed/setup/deploy/other/docker.md#component-images):
- `console/console-sm`

We currently have a script in the [camunda-helm-respository](https://github.com/camunda/camunda-platform-helm/blob/c6a6e0c327f2acb8746802fbe03b3774b8284de3/scripts/download-chart-docker-images.sh) that will assist in pulling and saving Docker images.
Expand Down
33 changes: 2 additions & 31 deletions versioned_docs/version-8.6/self-managed/setup/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,29 +282,6 @@ Camunda 8 components without a valid license may display **Non-Production Licens

## Configuring Web Modeler, Console, and Connectors

### Web Modeler and Console secrets

The Console and Web Modeler Components are published in Camunda's private Docker registry (registry.camunda.cloud) and are under a [proprietary license](/reference/licenses.md#web-modeler-and-console). These components are not available in public repositories.

To enable Kubernetes to pull the images from this registry, first [create an image pull secret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) using the credentials you received from Camunda:

```shell
kubectl create secret docker-registry registry-camunda-cloud \
--namespace=<NAMESPACE> \
--docker-server=registry.camunda.cloud \
--docker-username=<DOCKER_USER> \
--docker-password=<DOCKER_PASSWORD> \
--docker-email=<DOCKER_EMAIL>
```

:::note
Use `registry-camunda-cloud` as a secret after replacing `<DOCKER_USER>`, `<DOCKER_PASSWORD>`, and `<DOCKER_EMAIL>` with your credentials.

The secret must be created in the same Kubernetes namespace where you'll install the Helm chart. Replace `<NAMESPACE>` to set the namespace.
:::

Alternatively, create an image pull secret [from your Docker configuration file](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials).

### Install Connectors

The **Connector runtime** comes enabled by default. To start using Connectors, install Connector element templates. Learn more in our documentation for [Web Modeler](/components/connectors/manage-connector-templates.md) or [Desktop Modeler](/components/modeler/desktop-modeler/element-templates/configuring-templates.md).
Expand Down Expand Up @@ -376,19 +353,13 @@ For more details, check [Web Modeler Helm values](https://artifacthub.io/package

### Install Console

Console Self-Managed is disabled by default in the Camunda 8 Helm chart, as it requires a [proprietary license](/reference/licenses.md#web-modeler-and-console) to access the Camunda container registry.

To install Console, two steps are required:
Console Self-Managed is disabled by default in the Camunda 8 Helm chart.

1. [Create a secret with Camunda registry credentials](#web-modeler-console-secrets).
2. Enable Console, and reference the created Kubernetes secret object via Helm values.
To install Console, enable Console in the Helm chart with `console.enabled: true`. We recommend specifying these values in a YAML file that you pass to the `helm install` command:

```yaml
console:
enabled: true
image:
pullSecrets:
- name: registry-camunda-cloud
```

For more details, check [Console Helm values](https://artifacthub.io/packages/helm/camunda/camunda-platform#console-parameters).
Expand Down

0 comments on commit 080d51b

Please sign in to comment.