Skip to content

Commit

Permalink
docs: move "continuous delivery" pages in dedicated section (#67)
Browse files Browse the repository at this point in the history
* rename page and image to follow kebab-case convention
* Organize pages with sub-folders
* rename image
* adding description and page aliases

Covers
bonitasoft/bonita-documentation-site#589
  • Loading branch information
benjaminParisel authored Oct 18, 2024
1 parent 1dbcff8 commit 299547e
Show file tree
Hide file tree
Showing 59 changed files with 139 additions and 106 deletions.
24 changes: 0 additions & 24 deletions modules/ROOT/pages/Continuous_Delivery_Access.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/ROOT/pages/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ With Bonita Cloud starting a new project has never been easier:
+
NOTE: With Bonita Cloud no need to install any runtime, they're already available in our cloud.
+
. Configure your xref:Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc[Bonita Cloud Continuous Delivery platform].
. Configure your xref:continuous-delivery:configuring-the-platform.adoc[Bonita Cloud Continuous Delivery platform].
. Use Bonita Cloud Continuous Delivery platform to build and deploy your application to the Integration or Pre-production runtimes (xref:Continuous_Delivery_Build_and_deploy.adoc[Building and deploying to Bonita Cloud]).
+
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Retrieve Bonita AppRuntime Logs

:description: This page explains how to retrieve logs from Bonita AppRuntimes.
:page-aliases: ROOT:Retrieve_Bonita_runtime_logs.adoc

== Retrieve Bonita Logs Job

Expand All @@ -10,7 +10,7 @@ image:RetrieveLogsEntryPoint.png[]

== Retrieving the logs

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "ACTION - Retrieve Bonita AppRuntime logs" job.
. Click on the image:continuous-delivery:jenkins-play-button.png[CDPlayButton] of the "ACTION - Retrieve Bonita AppRuntime logs" job.
. This will open a form that enables you to configure the time range of the logs, the output format of the log file (csv or json) and the target AppRuntime
+
image:RetrieveLogsJob.png[]
Expand Down
30 changes: 15 additions & 15 deletions modules/ROOT/taxonomy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@
** xref:manage:sso-configuration.adoc[Single Sign-On Configuration]
** xref:manage:url-customization.adoc[URL customization]
* Continuous Delivery
** xref:Continuous_Delivery_Overview.adoc[Overview]
** xref:Continuous_Delivery_Access.adoc[Access]
** xref:Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc[Configuration]
** xref:Continuous_Delivery_Building_a_Living_Application.adoc[Building a Living Application]
** Deploying a Living Application
*** xref:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc[Non Production Runtimes]
*** xref:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc[Production Runtimes]
** xref:Continuous_Delivery_Build_and_deploy.adoc[Build and deploy a Living Application]
** xref:Continuous_Delivery_Test_a_Living_Application.adoc[Test a Living Application]
** xref:Continuous_Delivery_Managing_Living_Application_configuration.adoc[Managing Living Application configuration]
** xref:Retrieve_Bonita_runtime_logs.adoc[Retrieve Bonita runtime logs]
** xref:continuous-delivery:overview.adoc[Overview]
** xref:continuous-delivery:access.adoc[Access]
** xref:continuous-delivery:configuring-the-platform.adoc[Configuration]
** Living Applications
*** xref:continuous-delivery:living-application/build.adoc[Building a Living Application]
*** xref:continuous-delivery:living-application/deploying-to-bonita-cloud.adoc[Non Production Runtimes]
*** xref:continuous-delivery:living-application/deploy-in-prod-with-bonita-cloud.adoc[Production Runtimes]
*** xref:continuous-delivery:living-application/build-and-deploy.adoc[Build and deploy a Living Application]
*** xref:continuous-delivery:living-application/test-a-living-application.adoc[Test a Living Application]
*** xref:continuous-delivery:living-application/manage-configuration.adoc[Managing Living Application configuration]
** xref:retrieve-bonita-runtime-logs.adoc[Retrieve Bonita runtime logs]
** Basic actions
*** xref:Continuous_Delivery_Generic_Actions_Monitoring.adoc[Monitoring a job]
*** xref:Continuous_Delivery_Generic_Actions_Parameters.adoc[Check the parameters of a job]
*** xref:Continuous_Delivery_Generic_Actions_Replay.adoc[Replay a job]
*** xref:Continuous_Delivery_Generic_Actions_ChangePWD.adoc[Change your password]
*** xref:continuous-delivery:basic-actions/monitoring.adoc[Monitoring a job]
*** xref:continuous-delivery:basic-actions/check-parameters.adoc[Check the parameters of a job]
*** xref:continuous-delivery:basic-actions/replay.adoc[Replay a job]
*** xref:continuous-delivery:basic-actions/change-password.adoc[Change your password]
* xref:faq.adoc[Frequently Asked Questions]
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
26 changes: 26 additions & 0 deletions modules/continuous-delivery/pages/access.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
= Accessing the Bonita Cloud Continuous Delivery Service
:description: Accessing the Bonita Cloud Continuous Delivery Service
:page-aliases: ROOT:Continuous_Delivery_Access.adoc

After subscribing to Bonita Cloud, you will be provided access to Bonita Cloud Continuous Delivery platform.

== Login

Access the URL and use the given credential to connect:

image:login-page.png[,70%]


== Home page

You land to this page:

image:login-home.png[,70%]


== First Connection

Please start by configuring your xref:configuring-the-platform.adoc[Continuous Delivery Service]

CAUTION: We strongly recommend that you xref:basic-actions/change-password.adoc[change your password].

Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
= Changing your password
:description: How to change your password
:page-aliases: ROOT:Continuous_Delivery_Generic_Actions_ChangePWD.adoc


. In the home page, click on your username in the top right of the page:
+
image:OpenUserSetup.png[]
image:open-user-setup.png[]
+
. Open the "Configure" page:
+
image:ConfigureEntryPoint.png[]
image:configure-entrypoint.png[]
+
. Search for the "Password" section, enter your new password and click on "Save" to apply the new configuration
+
image:NewPWD.png[]
image:new-password.png[]
+
. Reconnect with the new password
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
= Check the parameters of a previous job
:description: Learn how to check the parameters of a previous job
:page-aliases: ROOT:Continuous_Delivery_Generic_Actions_Parameters.adoc


. Open the corresponding job by clicking on its title:
+
image:OpenAJob.gif[]
image:open-a-job.gif[]
+
. Open the corresponding job instance by click on its ID in the main list or side list
+
image:OpenJobInstance.png[]
image:open-job-instance.png[]
+
. On the side panel, click on the "Parameters" entry:
+
image:AccessParameters.png[]
image:access-parameters.png[]
+
. You can now view the parameters used in the job instance.
+
image:DisplayParametersExample.png[]
image:display-parameters-example.png[]
Original file line number Diff line number Diff line change
@@ -1,33 +1,35 @@
= Monitoring a job
:description: Learn how to monitor a job
:page-aliases: ROOT:Continuous_Delivery_Generic_Actions_Monitoring.adoc

== Last job result information

The result of the last job is displayed next to the job:

* image:JobStatusInProgress.png[Inprogress]: Job is in progress
* image:JobStatusOK.png[JobOK]: Last job was successful
* image:JobStatusFailed.png[JobKO]: Last job was unsuccessful
* image:job-status-in-progress.png[Inprogress]: Job is in progress
* image:job-status-ok.png[JobOK]: Last job was successful
* image:job-status-failed.png[JobKO]: Last job was unsuccessful

_Example_

image:JobStatusLast.png[,100%]
image:job-status-last.png[,100%]

=== Console Output

You can check the different actions and logs done in a job through the "console output". This output can be view during or after the job execution.

. Open the corresponding job by clicking on its title:
+
image:OpenAJob.gif[]
image:open-a-job.gif[]
+
. Open the corresponding job instance by click on its ID in the main list or side list
+
image:OpenJobInstance.png[]
image:open-job-instance.png[]
+
. On the side panel, click on the "Console Output" entry:
+
image:ConsoleOutputAction.png[]
image:console-output-action.png[]
+
. You will see all the different actions and logs done during the job:
+
image:ConsoleOutputEx.gif[,100%]
image:console-output-ex.gif[,100%]
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
= Replay a job
:description: You can launch a job instance without changing its parameters thanks to the "Replay" action.
:page-aliases: ROOT:Continuous_Delivery_Generic_Actions_Replay.adoc

You can launch a job instance without changing its parameters thanks to the "Replay" action.
{description}

. Open the corresponding job by clicking on its title:
+
image:OpenAJob.gif[]
image:open-a-job.gif[]
+
. Open the corresponding job instance by click on its ID in the main list or side list
+
image:OpenJobInstance.png[]
image:open-job-instance.png[]
+
. On side panel, click on the "Replay" entry:
+
image:ReplayAJob.png[]
image:replay-a-job.png[]
+
. Click on the run button and job will be launched again *with the same parameters*:
+
image:ReplayAJobInstance.gif[]
image:replay-a-job-instance.gif[]
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@
= Configuring your Continuous Delivery Platform
:description: How to configure your delivery platform
:page-aliases: ROOT:Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc

== Location of the configuration

All the jobs linked to the configuration are grouped in the "Configuration" tab:
image:ConfigurationTab.png[CDConfigTab]
image:configuration-tab.png[CDConfigTab]

== Git repository credentials

This job allows you to configure your access to Git but also the https://documentation.bonitasoft.com/bcd/3.2/how_to_use_bcd_with_data_encrypted[BCD vault password].
[#repository_credentials]
== Git repository credentials
// BCD page is deleted on 4.0, that's why we need to hardcode the 3.6 version
This job allows you to configure your access to Git but also the xref:3.6@bcd:ROOT:how_to_use_bcd_with_data_encrypted.adoc[BCD vault password].

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "Configure my credentials" job.
. Click on the image:continuous-delivery:jenkins-play-button.png[CDPlayButton] of the "Configure my credentials" job.
. Enter the Git user that will have access to your repositories
. Enter the corresponding password for that account.
. If you are planning to use the BCD Vault, then you can enter the vault password. This field can be left empty.
. Click on the "Build" button to save the configuration
. Make sure the job was successful:
image:CredentialsJobResult.png[JobResult]
image:credentials-job-result.png[JobResult]

CAUTION: If your Git repository is hosted on GitHub.com, beginning August 13, 2021 password-based authentication will no longer be accepted. Instead, token-based authentication will be required using a https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token[personal access token]. Therefore you will have to enter your GitHub username in the **bonitaGitUsername** field and your authentication token in the **bonitaGitPassword** field of the "Configure my credentials" job.

== Maven repository credentials

This job allows you to configure your access to a private Maven repository.

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "Configure my private Maven repository" job.
. Click on the image:continuous-delivery:jenkins-play-button.png[CDPlayButton] of the "Configure my private Maven repository" job.
. Enter the url used to access your private Maven repository
. If your private Maven repository require authentication, please enter the username and password used to retrieve your private Maven artifacts, otherwise leave these fields blank
. Click on the "Build" button to save the configuration
. Make sure the job was successful:
image:ConfigureMavenJobResult.png[JobResult]
image:configure-maven-job-result.png[JobResult]

NOTE: The job only allows setting up a single private Maven repository, to set up multiple repositories please create a new case on the Customer Service Center.

Expand All @@ -38,30 +42,30 @@ This job allows you to define the default build parameters i.e. the repository U

NOTE: You can use the build job without configuring your default build configuration.

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "Configure my default build parameters - LivingApp" job.
. Click on the image:continuous-delivery:jenkins-play-button.png[CDPlayButton] of the "Configure my default build parameters - LivingApp" job.
. Enter the URL to your Bonita living application repository (e.g. "https://github.com/acme/myGreatLivingApp.git").
. Then enter the branch you will be building most of the time.
. Finally input the environment (as defined in your project) you will be used when building.
Your job should look like this:
image:BuildDefaultParameters.png[BuildDefaultExample]
image:build-default-parameters.png[BuildDefaultExample]
. Click on the "Build" button to save the configuration
. Make sure the job was successful:
image:DefBuildJobResult.png[JobResult]
image:def-build-job-result.png[JobResult]

== Default Deploy configuration

This job allows you to define the default build parameters i.e. the BCD Configuration and the target runtime (production, preproduction or integration).

NOTE: You can use the deploy job without configuring your default deploy configuration.

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "Configure my default deploy parameters - LivingApp" job.
. Click on the image:continuous-delivery:jenkins-play-button.png[CDPlayButton] of the "Configure my default deploy parameters - LivingApp" job.
. Enter the BCD configuration you wish to use to deploy your default living application
. Select the runtime to deploy to.
+
NOTE: the Bonita version is displayed next to the runtime name.
+
. Click on the "Build" button to save the configuration
. Make sure the job was successful:
image:DefDeployJobResult.png[JobResult]
image:def-deploy-job-result.png[JobResult]


Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
= Build and deploy a living application to Bonita Cloud Non Production Runtimes
:description: Explain how to build and deploy a living application to Bonita Cloud Non Production Runtimes
:page-aliases: ROOT:Continuous_Delivery_Build_and_deploy.adoc

== Build and deploy Job

This job combines the build and deploy jobs to streamline your build and deploy process with the development or production polices:

image:BuildDeployJob.png[]
image:build-deploy-job.png[]

== Launching a deployment

. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "ACTION - Build and Deploy a LivingApp to a non-production runtime" job.
. Click on the image:jenkins-play-button.png[CDPlayButton] of the "ACTION - Build and Deploy a LivingApp to a non-production runtime" job.
. Your default build and deploy configuration will be pre-loaded. If needed you can change it (includes the repository URL and branch)
. Select the target runtime (note that only non-production runtimes are available - to deploy in production see xref:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc[here])
. Select the target runtime (note that only non-production runtimes are available - to deploy in production see xref:living-application//deploying-to-bonita-cloud.adoc[here])
. If needed, you can fill xref:{bcdVersion}@bcd:ROOT:deployer.adoc#deployment_descriptor_file[the Deployment Descriptor] in the DEPLOY_JSON field to specify which resources have to be deployed, and with which policy. When used, if a deploy policy is declared in DEPLOY_JSON, it overrides the Development or Production Policies.
. You can specify the directory that contains the xref:Continuous_Delivery_Test_a_Living_Application.adoc[integration tests] with the INTEGRATION_TESTS_DIR optional field.
. You can specify the directory that contains the xref:living-application/test-a-living-application.adoc[integration tests] with the INTEGRATION_TESTS_DIR optional field.
. You can also select the deployment policies to apply. Warning: It may be overridden by policies inside DEPLOY_JSON.
+
[NOTE]
Expand Down Expand Up @@ -50,7 +52,7 @@ image:BuildDeployJob.png[]

If the job is successful, you can directly access the corresponding portal (in order to test) by click on the link displayed in the job history:

image:LinkToPortal.png[,100%]
image:link-to-portal.png[,100%]

=== Failed deployment

Expand Down
Loading

0 comments on commit 299547e

Please sign in to comment.