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

feat: Document several deployment strategies for UIB pages #2961

Open
wants to merge 2 commits into
base: 2024.3
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,41 @@ image:ui-builder/advanced-app/export-application.png[Export application]
Move the exported JSON application(s) in a designated `workspace` folder. This folder will be referenced during the build process.
You can store these applications in a Git repository too.

=== Build the production binary
=== Deployment strategies

There are several ways to deploy your application in production:

==== 1. Build the production binary

To create the production-ready binary, you need to build a Docker image. This image will contain the application(s) and the Bonita UI Builder runtime.

The xref:production-packaging.adoc#dockerfile[Dockerfile] and more details on how to build the Docker image can be found in this xref:production-packaging.adoc[dedicated page].

[NOTE]
====
This strategy is the most common and recommended way to deploy your application in production. It allows you to be close with the xref:getting-started:package-and-deploy-sca-application.adoc[application packaging] strategy.
====

==== 2. Use a default UI Builder image and mount and mounted volume

With this strategy, you can use the default Bonita UI Builder image and mount a volume containing your applications.

You don't need to build a new image, but you need to ensure the volume is correctly mounted and declared on the xref:applications:ui-builder/production-packaging.adoc#run-production-binaries [docker compose file].

[source, yaml]
----
volumes:
- <local-path>:/opt/appsmith/workspace/applications
----

[WARNING]
--
This strategy don't set by default the `BONITA_DEV_MODE` to `false`. You need to set it manually in the environment variables in docker compose file.
--

=== Run the production binary

After building the Docker image, run it by following xref:production-packaging.adoc#run-production-binaries[the specific instructions].
Run it by following xref:production-packaging.adoc#run-production-binaries[the specific instructions].

=== Access your Application

Expand Down
2 changes: 1 addition & 1 deletion modules/best-practices/pages/design-methodology.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Here again, the negotiation between the need and how it can be efficiently rende
When the UI mockups are precise enough from the workshops, they are ready to be implemented in Bonita:

* For forms: from the pool _Execution_ properties (instantiation form and case overview), and human tasks (task forms)
* For application pages: directly from the UI Designer
* For application pages: directly from the UI Builder

==== Business Data Model

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You have to add them manually if you want to deploy them. To do it:
* Add the desired default applications to your project
* In the pom.xml file, you will see the new dependencies added for the application

[[package-application]]
=== Packaging as a docker image

To package your application as a docker image, you need to run this commands at the root of your project:
Expand Down