| # |
| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| # |
| |
| name: serverlessworkflow |
| title: "SonataFlow Guides" |
| version: main |
| display_version: snapshot |
| prerelease: snapshot |
| start_page: index.adoc |
| nav: |
| - "modules/ROOT/nav.adoc" |
| asciidoc: |
| attributes: |
| # |
| # Names, labels and similar |
| # |
| product_name: SonataFlow |
| operator_name: SonataFlow Operator |
| operator_installation_namespace: sonataflow-operator-system |
| operator_controller_config: sonataflow-operator-controllers-config |
| quarkus_platform: io.quarkus.platform |
| kogito_sw_ga: kogito-quarkus-serverless-workflow |
| data_index_ref: Data Index |
| workflow_instance: workflow instance |
| workflow_instances: workflow instances |
| operator_openshift_keyword: sonataflow |
| operator_openshift_catalog: sonataflow-operator |
| operator_k8s_keyword: sonataflow |
| operator_k8s_subscription: my-sonataflow-operator |
| kogito_devservices_imagename: quay.io/kiegroup/kogito-data-index-ephemeral-nightly |
| sonataflow_devmode_imagename: quay.io/kiegroup/kogito-swf-devmode-nightly |
| sonataflow_builder_imagename: quay.io/kiegroup/kogito-swf-builder-nightly |
| sonataflow_devmode_devui_url: /q/dev/org.kie.kogito.kogito-quarkus-serverless-workflow-devui/ |
| serverless_logic_web_tools_name: Serverless Logic Web Tools |
| serverless_workflow_vscode_extension_name: KIE Serverless Workflow Editor |
| kie_kogito_examples_repo_name: incubator-kie-kogito-examples |
| |
| # Jobs service image and links |
| jobs_service_image_allinone_url: https://hub.docker.com/r/apache/incubator-kie-kogito-jobs-service-allinone |
| jobs_service_image_allinone: docker.io/apache/incubator-kie-kogito-jobs-service-allinone |
| jobs_service_image_ephemeral_url: https://hub.docker.com/r/apache/incubator-kie-kogito-jobs-service-ephemeral |
| jobs_service_image_postgresql_url: https://hub.docker.com/r/apache/incubator-kie-kogito-jobs-service-postgresql |
| jobs_service_image_usage_url: https://github.com/apache/incubator-kie-kogito-images#jobs-services-all-in-one |
| |
| # |
| # Versions |
| # |
| quarkus_version: 3.8.4 |
| quarkus_platform_version: 3.8.4 |
| java_min_version: 17+ |
| maven_min_version: 3.9.3 |
| graalvm_min_version: 22.3.0 |
| spec_version: 0.8 |
| vscode_version: 1.67.0 |
| kn_cli_version: 0.32.0 |
| kn_cli_tag: 0.32 |
| 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: 999-SNAPSHOT |
| # only used in downstream |
| operator_version: main |
| |
| # Persistence extensions for the kogito-swf-builder |
| groupId_quarkus-agroal: io.quarkus |
| artifactId_quarkus-agroal: quarkus-agroal |
| |
| groupId_quarkus-jdbc-postgresql: io.quarkus |
| artifactId_quarkus-jdbc-postgresql: quarkus-jdbc-postgresql |
| |
| groupId_kie-addons-quarkus-persistence-jdbc: org.kie |
| artifactId_kie-addons-quarkus-persistence-jdbc: kie-addons-quarkus-persistence-jdbc |
| |
| # |
| # URLs |
| # |
| kogito_examples_repository_url: https://github.com/apache/incubator-kie-kogito-examples |
| kogito_sw_examples_url: https://github.com/apache/incubator-kie-kogito-examples/tree/main/serverless-workflow-examples |
| kogito_sw_operator_examples_url: https://github.com/apache/incubator-kie-kogito-examples/tree/main/serverless-operator-examples |
| kogito_examples_url: https://github.com/apache/incubator-kie-kogito-examples.git |
| kogito_apps_url: https://github.com/apache/incubator-kie-kogito-apps/tree/main |
| kogito_runtimes_url: https://github.com/apache/incubator-kie-kogito-runtimes/tree/main |
| kogito_runtimes_swf_url: https://github.com/apache/incubator-kie-kogito-runtimes/tree/main/kogito-serverless-workflow/ |
| kogito_runtimes_swf_test_url: https://github.com/apache/incubator-kie-kogito-runtimes/tree/main/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 |
| cloud_events_url: https://cloudevents.io/ |
| cloud_events_sdk_url: https://github.com/cloudevents/sdk-java |
| cloud_events_git_url: https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents |
| 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 |
| kie_tools_releases_page_url: https://github.com/apache/incubator-kie-tools/releases |
| 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 |
| quarkus_guides_config_reference_url: https://quarkus.io/guides/config-reference |
| quarkus_guides_container_image_url: https://quarkus.io/guides/container-image |
| quarkus_guides_dev_services: https://quarkus.io/guides/getting-started-dev-services |
| quarkus_guides_infinispan_client_reference_url: https://quarkus.io/guides/infinispan-client-reference |
| quarkus_guides_logging_url: https://quarkus.io/guides/logging |
| quarkus_guides_profiles_url: https://quarkus.io/guides/config-reference#profiles |
| quarkus_guides_swaggerui_url: https://quarkus.io/guides/openapi-swaggerui |
| quarkus_url: https://quarkus.io/ |
| dev_services_url: https://quarkus.io/guides/dev-services |
| test_containers_url: https://www.testcontainers.org/ |
| smallrye_messaging_url: https://smallrye.io/smallrye-reactive-messaging/smallrye-reactive-messaging/3.3 |
| quarkus_config_url: https://quarkus.io/guides/config |
| quarkus_swagger_url: https://quarkus.io/guides/openapi-swaggerui |
| java_install_url: https://www.java.com/en/download/help/download_options.html |
| openjdk_install_url: https://openjdk.org/install/ |
| maven_install_url: https://maven.apache.org/install.html |
| docker_install_url: https://docs.docker.com/engine/install/ |
| 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://knative.dev/docs/client/install-kn/ |
| knative_eventing_url: https://knative.dev/docs/eventing/ |
| knative_eventing_trigger_url: https://knative.dev/docs/eventing/triggers/ |
| knative_eventing_sink_binding_url: https://knative.dev/docs/eventing/sinks/#sink-parameter-example |
| knative_quickstart_url: https://knative.dev/docs/install/quickstart-install/#install-the-knative-cli/ |
| knative_serving_install_yaml_url: https://knative.dev/docs/install/yaml-install/serving/install-serving-with-yaml/ |
| knative_eventing_install_yaml_url: https://knative.dev/docs/install/yaml-install/eventing/install-eventing-with-yaml/ |
| 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 |
| golang_install_url: https://go.dev/doc/install |
| serverless_logic_web_tools_url: https://start.kubesmarts.org/ |
| swf_executor_core_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-core |
| swf_fluent_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-fluent |
| swf_executor_rest_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-rest |
| swf_executor_python_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-python |
| swf_executor_grpc_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-grpc |
| swf_executor_events_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-kafka |
| swf_executor_service_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-executor-service |
| swf_executor_openapi_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-serverless-workflow-openapi-parser |
| rocksdb_addon_maven_repo_url: https://mvnrepository.com/artifact/org.kie.kogito/kogito-addons-persistence-rocksdb |
| rocksdb_url: https://rocksdb.org/ |
| github_tokens_url: https://github.com/settings/tokens |
| openshift_developer_sandbox_url: https://developers.redhat.com/developer-sandbox |
| openshift_application_data_services_service_account_url: https://console.redhat.com/application-services/service-accounts |
| openshift_application_data_services_service_registry_url: https://console.redhat.com/application-services/service-registry |
| openshift_application_data_services_apache_kafka_url: https://console.redhat.com/application-services/streams/kafkas |
| camel_url: https://camel.apache.org/ |
| visual_studio_code_url: https://code.visualstudio.com/ |
| visual_studio_code_swf_extension_url: https://marketplace.visualstudio.com/items?itemName=kie-group.swf-vscode-extension |
| k9s_url: https://k9scli.io/ |
| graalvm_url: https://www.graalvm.org/ |
| graalvm_native_image_url: https://www.graalvm.org/22.0/reference-manual/native-image/ |
| slf4j_simple_maven_repo_url: https://mvnrepository.com/artifact/org.slf4j/slf4j-simple |
| # must align this version |
| camel_extensions_url: https://camel.apache.org/camel-quarkus/3.2.x/reference/extensions |
| kaoto_url: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-kaoto |
| minikube_url: https://minikube.sigs.k8s.io |
| minikube_start_url: https://minikube.sigs.k8s.io/docs/start/ |
| kind_install_url: https://kind.sigs.k8s.io/docs/user/quick-start/#installation |
| kogito_serverless_operator_url: https://github.com/apache/incubator-kie-kogito-serverless-operator/ |
| docs_issues_url: https://github.com/apache/incubator-kie-kogito-docs/issues/new |
| ocp_local_url: https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.17 |
| ocp_knative_serving_install_url: https://docs.openshift.com/container-platform/4.12/serverless/install/installing-knative-serving.html |
| ocp_knative_eventing_install_url: https://docs.openshift.com/container-platform/4.12/serverless/install/installing-knative-eventing.html |
| ocp_kn_cli_url: https://docs.openshift.com/container-platform/4.12/serverless/install/installing-kn.html |
| k8n_secrets_url: https://kubernetes.io/docs/concepts/configuration/secret |
| |
| # |
| # xreferences to documents within the documentation |
| # |
| data_index_xref: xref:data-index/data-index-core-concepts.adoc |
| job_service_xref: xref:job-services/core-concepts.adoc |
| |
