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

SRVLOGIC-516: Update midstream documenation for 1.35.0 #118

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
c65845d
SRVLOGIC-516: Update anotra.yml with version
domhanak Jan 9, 2025
cf7ee9a
SRVLOGIC-516: Add common doc file for eventing
domhanak Jan 9, 2025
b317a81
SRVLOGIC-516: Update custom ca certificate guide
domhanak Jan 9, 2025
fa3129a
SRVLOGIC-516: Update build-and-deploy-workflows.adoc
domhanak Jan 9, 2025
2f00d89
SVRLOGIC-516: Add configuring-workflow-eventing-system.adoc
domhanak Jan 9, 2025
6d475e4
SRVLOGIC-516: Update global-configuration.adoc
domhanak Jan 9, 2025
12c86ec
SRVLOGIC-516: Update install-serverless-operator.adoc
domhanak Jan 9, 2025
00dd707
SRVLOGIC-516: Update supporting-services.adoc
domhanak Jan 9, 2025
37994f3
SRVLOGIC-516: Finalize cloud section update
domhanak Jan 9, 2025
e786ebe
SRVLOGIC-516: Update core section
domhanak Jan 9, 2025
9cc07c7
SRVLOGIC-516: Finalize data-index section update
domhanak Jan 9, 2025
a99a907
SRVLOGIC-516: Update migration and kn cli guide
domhanak Jan 9, 2025
3387fd0
SRVLOGIC-516: Update tooling adocs for 1.35.0
domhanak Jan 9, 2025
3b83fa8
SRVLOGIC-516: Update expo-metrics-to-prometheus.adoc
domhanak Jan 9, 2025
901779f
SRVLOGIC-516: Fix typo
domhanak Jan 9, 2025
2b08285
SRVLOGIC-516: Parametrize install-kn-workflow-plugin.adoc
domhanak Jan 9, 2025
c8ad2b2
Fix missing attributes
domhanak Jan 9, 2025
e898961
Fix data-index-service.adoc referencing old images
domhanak Jan 9, 2025
7500689
Update quarkus_platform_version
domhanak Jan 10, 2025
5812294
Update kn_workflow_plugin_releases_url
domhanak Jan 10, 2025
bb50476
Update kogito_runtimes_swf_url missing slash
domhanak Jan 10, 2025
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
75 changes: 42 additions & 33 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ asciidoc:
# Serverless Logic - Names, labels and similar
#
product_name: OpenShift Serverless Logic
kogito_version_redhat: 9.100.0.redhat-00004
kogito_branch: 9.100.x-prod
kogito_branch: 9.102.x-prod
operator_name: Serverless Logic Operator
operator_installation_namespace: openshift-serverless-logic
sonataflow_vscode_extension_name: KIE Serverless Workflow Editor
operator_controller_config: sonataflow-operator-controllers-config
operator_controller_manager_deployment_name: logic-operator-rhel8-controller-manager
quarkus_platform: com.redhat.quarkus.platform
kogito_sw_ga: org.apache.kie.sonataflow:sonataflow-quarkus
data_index_ref: Data Index
Expand All @@ -33,10 +34,12 @@ asciidoc:
operator_openshift_catalog: logic-rhel8-operator
operator_k8s_keyword: sonataflow
operator_k8s_subscription: my-sonataflow-operator
container_image_registry_base: registry.redhat.io/openshift-serverless-1
sonataflow_operator_imagename: registry.redhat.io/openshift-serverless-1/logic-rhel8-operator
osl_kn_cli_imagename: registry.redhat.io/openshift-serverless-1/kn-workflow-cli-artifacts-rhel8
kogito_devservices_imagename: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8
sonataflow_devmode_imagename: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8
sonataflow_builder_imagename: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8
sonataflow_builder_configmap_name: logic-operator-rhel8-builder-config
sonataflow_dataindex_ephemeral_imagename: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8
sonataflow_dataindex_postgresql_imagename: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8
sonataflow_devmode_devui_url: /q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/
Expand All @@ -51,30 +54,34 @@ asciidoc:
jobs_service_image_postgresql_name: logic-jobs-service-postgresql-rhel8
jobs_service_image_postgresql: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8
jobs_service_image_postgresql_url: https://catalog.redhat.com/software/containers/openshift-serverless-1/logic-jobs-service-postgresql-rhel8/6614eddbaeb155f6aae45385
jobs_service_image_usage_url: https://github.com/kiegroup/kogito-images/tree/9.100.x-prod#jobs-services-all-in-one

#
# Versions
#
quarkus_version: 3.8.4.redhat-00002
quarkus_platform_version: 3.8.4.redhat-00002
quarkus_version: 3.8.6.redhat-00004
quarkus_platform_version: 3.8.6.SP2-redhat-00002
java_min_version: 17+
maven_min_version: 3.9.3
graalvm_min_version: 22.3.0
spec_version: 0.8
vscode_version: 1.84.0
kn_cli_version: 1.33.0
kn_cli_version: 1.35.0
docker_min_version: 20.10.7
docker_compose_min_version: 1.27.2
kubernetes_version: 1.26
openshift_version_min: 4.12
openshift_version_max: 4.15
knative_version: 1.13
knative_serving_version: 1.13
knative_eventing_version: 1.13
kogito_version: 9.100.0.redhat-00004
openshift_version_max: 4.17
knative_version: 1.15
knative_serving_version: 1.15
knative_eventing_version: 1.15
apache_kie_latest_version: 10.0.0
kogito_version: 9.102.0.redhat-00005
kogito_version_redhat: 9.102.0.redhat-00005
product_version_short: 1.35
product_version_long: 1.35.0
product_version_previous_long: 1.34.0
# only used in downstream
operator_version: 1.33.0
operator_version: 1.35.0

# Persistence extensions for the kogito-swf-builder
groupId_quarkus-agroal: io.quarkus
Expand All @@ -89,14 +96,17 @@ asciidoc:
#
# URLs
#
kogito_examples_repository_url: https://github.com/kiegroup/kogito-examples/tree/9.100.x-prod
kogito_sw_examples_url: https://github.com/kiegroup/kogito-examples/tree/9.100.x-prod/serverless-workflow-examples
kogito_sw_operator_examples_url: https://github.com/kiegroup/kogito-examples/tree/9.100.x-prod/serverless-operator-examples
images_distributions_url: https://catalog.redhat.com/
apple_support_url: https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac
kogito_examples_repository_url: https://github.com/kiegroup/kogito-examples/tree/{kogito_branch}
kogito_operator_repository_rawcontent_url: https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/
kogito_sw_examples_url: https://github.com/kiegroup/kogito-examples/tree/{kogito_branch}/serverless-workflow-examples
kogito_sw_operator_examples_url: https://github.com/kiegroup/kogito-examples/tree/{kogito_branch}/serverless-operator-examples
kogito_examples_url: https://github.com/kiegroup/kogito-examples.git
kogito_apps_url: https://github.com/kiegroup/kogito-apps/tree/9.100.x-prod
kogito_runtimes_url: https://github.com/kiegroup/kogito-runtimes/tree/9.100.x-prod
kogito_runtimes_swf_url: https://github.com/kiegroup/kogito-runtimes/tree/9.100.x-prod/kogito-serverless-workflow/
kogito_runtimes_swf_test_url: https://github.com/kiegroup/kogito-runtimes/tree/9.100.x-prod/kogito-serverless-workflow/kogito-serverless-workflow-executor-tests/src/test/java/org/kie/kogito/serverless/workflow/executor
kogito_apps_url: https://github.com/kiegroup/kogito-apps/tree/{kogito_branch}
kogito_runtimes_url: https://github.com/kiegroup/kogito-runtimes/tree/{kogito_branch}
kogito_runtimes_swf_url: https://github.com/kiegroup/kogito-runtimes/tree/{kogito_branch}/kogito-serverless-workflow/
kogito_runtimes_swf_test_url: https://github.com/kiegroup/kogito-runtimes/tree/{kogito_branch}/kogito-serverless-workflow/kogito-serverless-workflow-executor-tests/src/test/java/org/kie/kogito/serverless/workflow/executor
quarkus_cli_url: https://quarkus.io/guides/cli-tooling
spec_website_url: https://serverlessworkflow.io/
spec_doc_url: https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md
Expand All @@ -106,7 +116,7 @@ asciidoc:
open_api_spec_url: https://spec.openapis.org/oas/v3.1.0.html
open_api_swagger_spec_url: https://swagger.io/docs/specification
quarkus_openapi_gen_url: https://github.com/quarkiverse/quarkus-openapi-generator
kn_workflow_plugin_releases_url: https://developers.redhat.com/content-gateway/rest/mirror/pub/cgw/serverless-logic/1.33.0/
kn_workflow_plugin_releases_url: https://developers.redhat.com/content-gateway/rest/mirror/pub/cgw/serverless-logic/{product_version_long}/
quarkus_guides_base_url: https://quarkus.io/guides
quarkus_guides_kafka_url: https://quarkus.io/guides/kafka
quarkus_guides_building_native: https://quarkus.io/guides/building-native-image
Expand All @@ -130,15 +140,15 @@ asciidoc:
podman_install_url: https://docs.podman.io/en/latest/
kubectl_install_url: https://kubernetes.io/docs/tasks/tools/install-kubectl
docker_compose_install_url: https://docs.docker.com/compose/install/
kn_cli_install_url: https://docs.openshift.com/serverless/1.33/install/installing-kn.html
knative_eventing_url: https://docs.openshift.com/serverless/1.33/eventing/knative-eventing.html
knative_eventing_broker_url: https://docs.openshift.com/serverless/1.33/eventing/brokers/serverless-brokers.html
knative_eventing_kafka_broker_url: https://docs.openshift.com/serverless/1.33/eventing/brokers/serverless-broker-types.html
knative_eventing_trigger_url: https://docs.openshift.com/serverless/1.33/eventing/triggers/serverless-triggers.html
knative_eventing_sink_binding_url: https://docs.openshift.com/serverless/1.33/eventing/event-sinks/serverless-event-sinks.html
knative_quickstart_url: https://docs.openshift.com/serverless/1.33/install/installing-kn.html
knative_serving_install_yaml_url: https://docs.openshift.com/serverless/1.33/install/installing-knative-serving.html
knative_eventing_install_yaml_url: https://docs.openshift.com/serverless/1.33/install/installing-knative-eventing.html
kn_cli_install_url: https://docs.openshift.com/serverless/{product_version_short}/install/installing-kn.html
knative_eventing_url: https://docs.openshift.com/serverless/{product_version_short}/eventing/knative-eventing.html
knative_eventing_broker_url: https://docs.openshift.com/serverless/{product_version_short}/eventing/brokers/serverless-brokers.html
knative_eventing_kafka_broker_url: https://docs.openshift.com/serverless/{product_version_short}/eventing/brokers/serverless-broker-types.html
knative_eventing_trigger_url: https://docs.openshift.com/serverless/{product_version_short}/eventing/triggers/serverless-triggers.html
knative_eventing_sink_binding_url: https://docs.openshift.com/serverless/{product_version_short}/eventing/event-sinks/serverless-event-sinks.html
knative_quickstart_url: https://docs.openshift.com/serverless/{product_version_short}/install/installing-kn.html
knative_serving_install_yaml_url: https://docs.openshift.com/serverless/{product_version_short}/install/installing-knative-serving.html
knative_eventing_install_yaml_url: https://docs.openshift.com/serverless/{product_version_short}/install/installing-knative-eventing.html
kafka_doc_url: https://kafka.apache.org/documentation/
node_install_url: https://nodejs.org/en/download/package-manager/
pnpm_install_url: https://pnpm.io/installation
Expand Down Expand Up @@ -187,9 +197,8 @@ asciidoc:
job_service_xref: xref:job-services/core-concepts.adoc

# Tag to use with community-only images
operator_community_prod_yaml: https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/9.100.x-prod/operator.yaml
operator_community_prod_root: https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/9.100.x-prod
sonataflow_operator_imagename: registry.redhat.io/openshift-serverless-1/logic-rhel8-operator
operator_community_prod_yaml: https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/{kogito_branch}/operator.yaml
operator_community_prod_root: https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/{kogito_branch}
java_install: 'https://www.java.com/en/download/help/download_options.html'
maven_install: 'https://maven.apache.org/install.html'
docker_install: 'https://docs.docker.com/engine/install/'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[source,yam]
----
apiVersion: sonataflow.org/v1alpha08
kind: SonataFlowPlatform
metadata:
name: sonataflow-platform-example
namespace: example-namespace
spec:
eventing:
broker:
ref:
name: example-broker <1>
namespace: example-broker-namespace <2>
apiVersion: eventing.knative.dev/v1
kind: Broker
----

<1> Name of the Knative Eventing Broker.
<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults to the SonataFlowPlatform namespace. We recommend creating the Knative Eventing Broker in the same namespace as the SonataFlowPlatform.

[NOTE]
====
In production environments, you must use a production-ready broker, like the link:{knative_eventing_kafka_broker_url}[Knative Kafka Broker].
====
8 changes: 8 additions & 0 deletions modules/serverless-logic/pages/cloud/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,14 @@ xref:cloud/operator/using-persistence.adoc[]
Learn how to define the workflow `Persistence` field to allow the workflow to store its context
--

[.card]
--
[.card-title]
xref:cloud/operator/enabling-jobs-service.adoc[]
[.card-description]
Learn how to enable the Jobs Service with Operator
--

[.card]
--
[.card-title]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,16 @@ spec:

Similar to a deployment spec, a serverless workflow has a spec.podTemplate, with minor differences, but the change is almost identical.
In this case, we are mounting some ingress ca-bundle because we want our workflow to reach the `.apps.my-cluster-name.my-cluster-domain` SSL endpoint.

In this example, we pull the ingress CA of OpenShift's ingress deployment because this is the CA that signs the target routes' certificates. It can be any CA that is signing the target service certificate.
Here's how to copy the ingress ca cert to the desired namespace:

[source,shell]
---
kubectl config set-context --current --namespace=my-namespace
kubectl get cm -n openshift-config-managed default-ingress-cert -o yaml | awk '!/namespace:.*$/' | sed 's/default-ingress-cert/ingress-ca/' | kubectl create -f -
---

Here is the relevant spec section of a workflow with the changes:

[source,yaml]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ kubectl patch sonataflowplatform <name> --patch 'spec:\n build:\n config:
[#customize-base-build]
=== Customize the base build Dockerfile

The operator uses the `ConfigMap` named `logic-operator-builder-config` in the operator's installation namespace ({operator_installation_namespace}) to configure and run the workflow build process.
The operator uses the `ConfigMap` named `{sonataflow_builder_configmap_name}` in the operator's installation namespace ({operator_installation_namespace}) to configure and run the workflow build process.
You can change the `Dockerfile` entry in this `ConfigMap` to tailor the Dockerfile to your needs. Just be aware that this can break the build process.

.Example of the sonataflow-operator-builder-config `ConfigMap`
Expand All @@ -83,8 +83,8 @@ data:
-Djava.util.logging.manager=org.jboss.logmanager.LogManager\"\nENV JAVA_APP_JAR=\"/deployments/quarkus-run.jar\"\n"
kind: ConfigMap
metadata:
name: sonataflow-operator-builder-config
namespace: sonataflow-operator-system
name: {sonataflow_builder_configmap_name}
namespace: {operator_installation_namespace}
----

[WARNING]
Expand Down Expand Up @@ -355,7 +355,7 @@ spec:
strategyOptions:
KanikoBuildCacheEnabled: "true"
registry:
address: registry.redhat.io/openshift-serverless-1 <1>
address: {container_image_registry_base} <1>
secret: regcred <2>
----

Expand Down Expand Up @@ -429,7 +429,7 @@ If you are running on OpenShift, you have access to the Red Hat's supported regi

[source,bash,subs="attributes+"]
----
kubectl edit cm/sonataflow-operator-builder-config -n {operator_installation_namespace}
kubectl edit cm/{sonataflow_builder_configmap_name} -n {operator_installation_namespace}
----

In your editor, change the first line in the `Dockerfile` entry where it reads `FROM {sonataflow_builder_imagename}:{operator_version}` to the desired image.
Expand Down
Loading