wmedvede commented on code in PR #721: URL: https://github.com/apache/incubator-kie-kogito-docs/pull/721#discussion_r2071311288
########## serverlessworkflow/modules/ROOT/pages/cloud/operator/gitops-profile.adoc: ########## @@ -0,0 +1,124 @@ += GitOps Profile +:compat-mode!: +// Metadata: +:description: Using GitOps profile for deploying SonataFlow workflows in production environments +:keywords: sonataflow, workflow, serverless, operator, kubernetes, gitops, cicd +// Links: +:rh_jdk17_url: https://catalog.redhat.com/software/containers/ubi9/openjdk-17/61ee7c26ed74b2ffb22b07f6 + +This document describes how to use the GitOps profile for deploying {product_name} workflows in production environments. + +== Recommended for Production + +Using the GitOps profile is recommended for production environments. It provides complete control over workflow image builds, enabling compliance, security, and seamless integration into your existing CI/CD pipelines. + +== Workflow Image Structure + +The GitOps profile uses container images based on the link:{rh_jdk17_url}[Red Hat OpenJDK 17 UBI 9] runtime. You can review its documentation for detailed information about the image architecture. Review Comment: Here we are using UBI 9, and en the by default configuration provided by operator for the preview profiled builds. Which is fine. However in in the builder image module we have UBI 9 https://github.com/apache/incubator-kie-tools/blob/main/packages/sonataflow-builder-image/resources/incubator-kie-sonataflow-builder-image.yaml#L20 Should we align this last to UBI 9 ? or better to not? maybe OSL needs UBI 9 :thinking: ########## serverlessworkflow/modules/ROOT/nav.adoc: ########## @@ -51,10 +51,11 @@ ** Operator *** xref:cloud/operator/install-serverless-operator.adoc[Installation] *** xref:cloud/operator/global-configuration.adoc[Admin Configuration] -*** Deployment Model +*** xref:cloud/operator/deployment-model.adoc[Deployment Model] Review Comment: ```suggestion *** xref:cloud/operator/deployment-model.adoc[Deployment Models] ``` ########## serverlessworkflow/modules/ROOT/pages/cloud/operator/deployment-model.adoc: ########## @@ -0,0 +1,51 @@ += Deployment Models +:compat-mode!: +// Metadata: +:description: Overview of deployment models for SonataFlow workflows +:keywords: sonataflow, workflow, serverless, operator, kubernetes, gitops, devmode, preview + +This document introduces the three deployment profiles supported by the {product_name} Operator, each tailored for specific use cases and operational scenarios in Kubernetes environments. + +== GitOps Profile + +The GitOps profile provides maximum flexibility and control over workflow deployments, suitable for production environments. In this model, container images are built externally via your own CI/CD pipelines. The {product_name} Operator deploys workflows using these externally built container images referenced in the SonataFlow Custom Resource. This profile is ideal for environments where compliance, auditing, and advanced security requirements are critical. + +xref:cloud/operator/gitops-profile.adoc[Read more about the GitOps Profile]. + +== Preview Profile + +The Preview profile automates building and deploying workflow container images. The {product_name} Operator handles the full build lifecycle internally, enabling quick deployments and iterative testing in environments closely resembling production without manually managing container images. This profile is beneficial for final pre-production validation and demonstrations. + +xref:cloud/operator/build-and-deploy-workflows.adoc[Read more about the Preview Profile]. + +== Development Profile + +The Development profile offers rapid iteration and live reloading capabilities tailored for workflow development. It simplifies the workflow application lifecycle by dynamically building and deploying workflow changes as they occur, enabling quick feedback loops during development. This profile supports custom development images for extending base functionalities. + +xref:cloud/operator/developing-workflows.adoc[Read more about the Development Profile]. + +== Choosing the Right Profile + +Select a deployment profile based on your specific needs: + +* **GitOps** for controlled, production-ready deployments integrated into your own CI/CD. +* **Preview** for automated image builds suitable for staging or demo environments. +* **Development** for rapid iteration and dynamic testing during workflow development. + +== Switching Between Profiles + +To change between profiles, you must set the SonataFlow custom resource annotation: + +[source,yaml] +---- +apiVersion: sonataflow.org/v1alpha08 +kind: SonataFlow +metadata: + annotations: + org.sonataflow/profile: +---- + +Valid values for <profile> are dev, gitops, or preview. Review Comment: ```suggestion Valid values for are `dev`, `gitops`, or `preview`. ``` [NOTE] ==== When you deploy a workflow without a configured profile, the `preview` profile selected by default. ==== ########## serverlessworkflow/modules/ROOT/pages/cloud/operator/deployment-model.adoc: ########## @@ -0,0 +1,51 @@ += Deployment Models +:compat-mode!: +// Metadata: +:description: Overview of deployment models for SonataFlow workflows +:keywords: sonataflow, workflow, serverless, operator, kubernetes, gitops, devmode, preview + +This document introduces the three deployment profiles supported by the {product_name} Operator, each tailored for specific use cases and operational scenarios in Kubernetes environments. + +== GitOps Profile + +The GitOps profile provides maximum flexibility and control over workflow deployments, suitable for production environments. In this model, container images are built externally via your own CI/CD pipelines. The {product_name} Operator deploys workflows using these externally built container images referenced in the SonataFlow Custom Resource. This profile is ideal for environments where compliance, auditing, and advanced security requirements are critical. + +xref:cloud/operator/gitops-profile.adoc[Read more about the GitOps Profile]. + +== Preview Profile + +The Preview profile automates building and deploying workflow container images. The {product_name} Operator handles the full build lifecycle internally, enabling quick deployments and iterative testing in environments closely resembling production without manually managing container images. This profile is beneficial for final pre-production validation and demonstrations. + +xref:cloud/operator/build-and-deploy-workflows.adoc[Read more about the Preview Profile]. + +== Development Profile + +The Development profile offers rapid iteration and live reloading capabilities tailored for workflow development. It simplifies the workflow application lifecycle by dynamically building and deploying workflow changes as they occur, enabling quick feedback loops during development. This profile supports custom development images for extending base functionalities. + +xref:cloud/operator/developing-workflows.adoc[Read more about the Development Profile]. + +== Choosing the Right Profile + +Select a deployment profile based on your specific needs: + +* **GitOps** for controlled, production-ready deployments integrated into your own CI/CD. +* **Preview** for automated image builds suitable for staging or demo environments. +* **Development** for rapid iteration and dynamic testing during workflow development. + +== Switching Between Profiles + +To change between profiles, you must set the SonataFlow custom resource annotation: + +[source,yaml] +---- +apiVersion: sonataflow.org/v1alpha08 +kind: SonataFlow +metadata: + annotations: + org.sonataflow/profile: Review Comment: ```suggestion org.sonataflow/profile: gitops ``` ########## serverlessworkflow/modules/ROOT/pages/cloud/operator/deployment-model.adoc: ########## @@ -0,0 +1,51 @@ += Deployment Models +:compat-mode!: +// Metadata: +:description: Overview of deployment models for SonataFlow workflows +:keywords: sonataflow, workflow, serverless, operator, kubernetes, gitops, devmode, preview + +This document introduces the three deployment profiles supported by the {product_name} Operator, each tailored for specific use cases and operational scenarios in Kubernetes environments. + +== GitOps Profile + +The GitOps profile provides maximum flexibility and control over workflow deployments, suitable for production environments. In this model, container images are built externally via your own CI/CD pipelines. The {product_name} Operator deploys workflows using these externally built container images referenced in the SonataFlow Custom Resource. This profile is ideal for environments where compliance, auditing, and advanced security requirements are critical. + +xref:cloud/operator/gitops-profile.adoc[Read more about the GitOps Profile]. + +== Preview Profile + +The Preview profile automates building and deploying workflow container images. The {product_name} Operator handles the full build lifecycle internally, enabling quick deployments and iterative testing in environments closely resembling production without manually managing container images. This profile is beneficial for final pre-production validation and demonstrations. + +xref:cloud/operator/build-and-deploy-workflows.adoc[Read more about the Preview Profile]. + +== Development Profile + +The Development profile offers rapid iteration and live reloading capabilities tailored for workflow development. It simplifies the workflow application lifecycle by dynamically building and deploying workflow changes as they occur, enabling quick feedback loops during development. This profile supports custom development images for extending base functionalities. + +xref:cloud/operator/developing-workflows.adoc[Read more about the Development Profile]. + +== Choosing the Right Profile + +Select a deployment profile based on your specific needs: + +* **GitOps** for controlled, production-ready deployments integrated into your own CI/CD. +* **Preview** for automated image builds suitable for staging or demo environments. +* **Development** for rapid iteration and dynamic testing during workflow development. + +== Switching Between Profiles + +To change between profiles, you must set the SonataFlow custom resource annotation: Review Comment: ```suggestion To change between profiles, you must set the SonataFlow custom resource annotation `org.sonataflow/profile`: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
