Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(self-managed): OpenShift ROSA instructions and rework of the reference arch for OpenShift #4734

Merged
merged 35 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
a9f4dba
init doc openshift
leiicamundi Nov 14, 2024
a020855
fix openshift doc
leiicamundi Nov 15, 2024
87eb430
fix doc
leiicamundi Nov 15, 2024
4c0c50a
fix doc
leiicamundi Nov 15, 2024
a7044c2
fix text
leiicamundi Nov 18, 2024
ffc02a7
Merge branch 'main' into feature/aws_rosa_hcp
leiicamundi Nov 19, 2024
ca418aa
update openshift doc with routes rework
leiicamundi Nov 19, 2024
ceec066
implement routes deployment
leiicamundi Nov 19, 2024
0d05df4
fix link routes
leiicamundi Nov 21, 2024
01919f5
init dual-region doc
leiicamundi Nov 21, 2024
8416621
update todo
leiicamundi Nov 22, 2024
6105222
Merge branch 'main' into feature/aws_rosa_hcp
leiicamundi Nov 22, 2024
b2f5be8
wip
leiicamundi Dec 4, 2024
842b27a
add diagrams for rosa arch
leiicamundi Dec 4, 2024
0b4c634
remove route definition
leiicamundi Dec 5, 2024
e9442d0
backport rosa
leiicamundi Dec 5, 2024
34d37df
update 8.7 doc
leiicamundi Dec 6, 2024
c84620c
fix format partially
leiicamundi Dec 6, 2024
bda3f7c
update instructions for core api
leiicamundi Dec 6, 2024
c6947fa
Merge branch 'main' into feature/rosa_hcp_8.6
leiicamundi Dec 9, 2024
19aa9e7
remove dual-region
leiicamundi Dec 9, 2024
be91279
tech writer edits, indentation
conceptualshark Dec 9, 2024
a57c173
update cidr of diagrams
leiicamundi Dec 10, 2024
23c5cef
fix deadlink
leiicamundi Dec 10, 2024
ef985c2
fix deadlink and es reference
leiicamundi Dec 10, 2024
a711e75
add caution about differences of the module and official
leiicamundi Dec 11, 2024
ae467b0
indicate usage of user vs dedicated
leiicamundi Dec 11, 2024
8703d31
improve instructions for style
leiicamundi Dec 11, 2024
886e6eb
remove title level 1
leiicamundi Dec 11, 2024
78fb058
reword the cli auth part
leiicamundi Dec 11, 2024
6137ff7
editing pass
conceptualshark Dec 11, 2024
ec3911b
Update docs/self-managed/setup/deploy/amazon/openshift/terraform-setu…
leiicamundi Dec 12, 2024
617de45
remove mentions of keycloak pg db password
leiicamundi Dec 20, 2024
f6b5a16
use reference branch for files
leiicamundi Dec 20, 2024
5c91821
Merge branch 'main' into feature/rosa_hcp_8.6
leiicamundi Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: "Install Camunda 8 on an EKS cluster"
description: "Set up the Camunda 8 environment with Helm and an optional Ingress setup on Amazon EKS."
---

<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/openshift/terraform-setup.md. The user should have a similar experience when reading both guides. -->
leiicamundi marked this conversation as resolved.
Show resolved Hide resolved

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

Expand All @@ -30,6 +32,7 @@ Multi-tenancy is disabled by default and is not covered further in this guide. I
:::caution Optimize compatibility with OpenSearch

**Migration:** The migration step will be disabled during the installation. For more information, refer to [using Amazon OpenSearch Service](/self-managed/setup/guides/using-existing-opensearch.md).

:::

## Architecture
Expand Down Expand Up @@ -569,7 +572,7 @@ Below is a summary of the necessary instructions:
1. Open Identity in your browser at `https://${DOMAIN_NAME}/identity`. You will be redirected to Keycloak and prompted to log in with a username and password.
2. Use `demo` as both the username and password.
3. Select **Add application** and select **M2M** as the type. Assign a name like "test."
4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Zeebe API** with "write" permission.
4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Core API** with "read" and "write" permission.
5. Retrieve the `client-id` and `client-secret` values from the application details

```shell
Expand All @@ -591,7 +594,7 @@ kubectl port-forward services/camunda-keycloak 18080:80 --namespace camunda
1. Open Identity in your browser at `http://localhost:8080`. You will be redirected to Keycloak and prompted to log in with a username and password.
2. Use `demo` as both the username and password.
3. Select **Add application** and select **M2M** as the type. Assign a name like "test."
4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Zeebe API** with "write" permission.
4. Select the newly created application. Then, select **Access to APIs > Assign permissions**, and select the **Core API** with "read" and "write" permission.
5. Retrieve the `client-id` and `client-secret` values from the application details

```shell
Expand Down
22 changes: 11 additions & 11 deletions docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,25 +96,25 @@ Advanced users may want to handle this part differently and use a different back
#### Set up AWS authentication

The [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) is required to create resources in AWS. Before you can use the provider, you must authenticate it using your AWS credentials.
You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods.

We recommend using the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials.
:::caution Ownership of the created resources

To configure the AWS CLI:
A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user.

```bash
aws configure
```
:::

Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
You can further change the region and other preferences and explore different [authentication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration) methods:

:::caution Ownership of the created resources
- For development or testing purposes you can use the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). If you have configured your AWS CLI, Terraform will automatically detect and use those credentials.
To configure the AWS CLI:

A user who creates resources in AWS will always retain administrative access to those resources, including any Kubernetes clusters created. It is recommended to create a dedicated [AWS IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for Terraform purposes, ensuring that the resources are managed and owned by that user.
```bash
aws configure
```

[Create access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` variables to use with the AWS CLI and `eksctl`
Enter your `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, region, and output format. These can be retrieved from the [AWS Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).

:::
- For production environments, we recommend the use of a dedicated IAM user. Create [access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for the new IAM user via the console, and export them as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.

#### Create an S3 bucket for Terraform state management

Expand Down
leiicamundi marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Loading