Skip to content

Commit

Permalink
596 - Review next 3 cloud chapters
Browse files Browse the repository at this point in the history
Review building-custom-images
Review customize-podspec
Review workflow-status-conditions
  • Loading branch information
domhanak committed May 22, 2024
1 parent 34ba2b3 commit be08505
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
// NOTE: this guide can be expanded in the future to include prod images, hence the file name
// please change the title section and rearrange the others once it's done

This document describes how to build a custom development image to use in SonataFlow.
This document describes how to build a custom development image to use in {product_name}.

== The development mode image structure

Expand Down Expand Up @@ -95,7 +95,7 @@ The container exposes port 8080 by default. When running the container locally,

Next, we mount a local volume to the container's application path. Any local workflow definitions, specification files, or properties should be mounted to `src/main/resources`. Alternatively, you can also mount custom Java files to `src/main/java`.

Finally, to use the new generated image with the dev profile you can see: xref:cloud/operator/developing-workflows.adoc#_using_another_workflow_base_image[Using another Workflow base image].
Finally, to use the new generated image with the dev profile follow the procedure at xref:cloud/operator/developing-workflows.adoc#_using_another_workflow_base_image[Using another Workflow base image] guide.

== Additional resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ In this scenario, the `.spec.resources` attribute is ignored since it's only use
xref:cloud/operator/known-issues.adoc[In the roadmap] you will find that we plan to consider the `.spec.resources` attribute when the image is specified in the default container.
====

It's advised that the SonataFlow `.spec.flow` definition and the workflow built within the image corresponds to the same workflow. If these definitions don't match you may experience poorly management and configuration. The {operator_name} uses the `.spec.flow` attribute to configure the application, service discovery, and service binding with other deployments within the topology.
It's advised that the SonataFlow `.spec.flow` definition and the workflow built within the image corresponds to the same workflow. If these definitions don't match you may experience poor management and configuration. The {operator_name} uses the `.spec.flow` attribute to configure the application, service discovery, and service binding with other deployments within the topology.

[IMPORTANT]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This document describes the Status and Conditions of a `SonataFlow` object manag

link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties[Kubernetes Status] is an important property to observe in order to understand what is currently happening with the object. It can also help you troubleshoot or integrate with other objects in the cluster.

You can inspect the Status of any Workflow object using the following command:
You can inspect the `Status` of any workflow object using the following command:

.Checking the Workflow Status
[source,bash,subs="attributes+"]
Expand All @@ -18,7 +18,7 @@ kubectl get workflow <your_workflow_name> -n <your_namespace> -o jsonpath={.stat

== General Status

The table below lists the general structure of a Workflow status:
The table below lists the general structure of a workflow status:

.Description of SonataFlow Status object
[cols="1,2"]
Expand All @@ -43,11 +43,11 @@ The `Conditions` property might vary depending on the Workflow profile. The next

== Development Profile Conditions

When you deploy a Workflow with the xref:cloud/operator/developing-workflows.adoc[development profile], the operator deploys a ready-to-use container with a running Workflow instance.
When you deploy a workflow with the xref:cloud/operator/developing-workflows.adoc[development profile], the operator deploys a ready-to-use container with a running workflow instance.

The following table lists the possible Conditions.
The following table lists the possible `Conditions`.

.Conditions Scenarios in Development
.Conditions Scenarios in Development mode
[cols="0,0,1,2"]
|===
|Condition | Status | Reason | Description
Expand Down Expand Up @@ -84,13 +84,13 @@ The following table lists the possible Conditions.

|===

In normal conditions, the Workflow will transition from `Running`, `WaitingForDeployment` condition to `Running`. In case something wrong happens, consult the section xref:cloud/operator/developing-workflows.adoc#troubleshooting[Workflow Troubleshooting in Development].
In normal conditions, the Workflow will transition from `Running` to `WaitingForDeployment`and to `Running` condition. In case something wrong happens, consult the section xref:cloud/operator/developing-workflows.adoc#troubleshooting[workflow troubleshooting in development mode].

== Production Profile Conditions
== Preview Profile Conditions

Deploying the Workflow in xref:cloud/operator/build-and-deploy-workflows.adoc[Production profile] makes the operator build an immutable image for the Workflow application. The progress of the immutable image build can be followed by observing the Workflow Conditions.
Deploying the Workflow in xref:cloud/operator/build-and-deploy-workflows.adoc[preview profile] makes the operator build an immutable image for the Workflow application. The progress of the immutable image build can be followed by observing the Workflow Conditions.

.Condition Scenarios in Production
.Condition Scenarios in Preview mode
[cols="0,0,1,2"]
|===
|Condition | Status | Reason | Description
Expand Down

0 comments on commit be08505

Please sign in to comment.