camunda / issues

4 stars 0 forks source link

Self-Managed Install: OpenShift configuration #783

Open engineering-issue-sync-app[bot] opened 3 weeks ago

engineering-issue-sync-app[bot] commented 3 weeks ago

For more information and best practices, please visit Confluence.

Value Proposition Statement 🚀

Enterprise customers looking to deploy Cmaunda 8 on OpenShift must understand how to prepare their OpenShift clusters for Camunda. They need an in-depth guide to ensure Camunda 8 is deployed successfully according to best practices.

User Problem 🤦

Users need to get a systematically documented deployment of Camunda C8 Self-Managed on an OpenShift cluster, ensuring the process is efficient, secure, and compliant with organizational standards while also enabling maintenance and scalability of the system in a production environment.

User Stories 🧑‍🚀

As IT Admin I need to verify that our OpenShift Cluster meets the necessary resource requirements for Camunda C8, so that I can ensure a smooth deployment.

As IT Admin I need to set up and configure \<%s> using OpenShift's, to ensure that all process data is reliably stored and retrievable.

Where %s

(persistent storage | network policies and ingress controllers | RBAC policies, SCC, and integrate enterprise authentication mechanisms )

As a QA engineer, I need to thoroughly test the Camunda C8 setup on OpenShift, to ensure that it meets our functional and performance requirements.

Implementation 👷

OpenShift Supported flavors. We can not test with all flavors of OS. We need to pick one. At the moment, we don't have a comprehensive customer survey, but based on some customer conversations OS on AWS seems to be most popular, followed by Self-managed OS. We can pick one flavor in this iteration that we can use and note some major differences as we discover them.

  1. Prerequisites Verification:

    • Ensure that your OpenShift Cluster meets the resource requirements for running Camunda C8, including CPU, memory, and storage. Customers would size a Camunda 8 by using https://docs.camunda.io/docs/components/best-practices/architecture/sizing-your-environment/. We should tie the sizing plan to OpenShift resource allocation.

    • Verify you have administrative (required) access to the OpenShift cluster to deploy applications and configure necessary resources.

  2. Persistent Storage Setup:

    • Configure persistent storage for Camunda C8, as it requires a database for storing process definitions, instances, and history data. You might use OpenShift's persistent volume claims (PVCs) to connect to storage solutions that Cloud Providers could support. While OS will use Cloud provider disks, we need to help users to map OS to Cloud Storage systems.
  3. Database Configuration:

    • Set up a database that Camunda C8 will use. Camunda supports various databases like PostgreSQL, MySQL, ElasticSearch, and OpenSearch. You can deploy the database within OpenShift or connect to an external database service.
  4. Networking and Ingress Configuration:

    • Configure network policies and ingress controllers in OpenShift for Camunda C8. This includes setting up routes or ingress resources to expose Camunda's services externally if required.
  5. Security and Compliance:

    • Configure security settings following your organization's policies. This may include setting up RBAC policies and Security Context Constraints (SCC) in OpenShift and integrating them with enterprise authentication\/authorization mechanisms.

    6. Testing and Validation:

    • After deployment, thoroughly test the Camunda C8 setup to ensure it's working as expected.

:robot: This issue is automatically synced from: source