diff --git a/modules/ROOT/pages/Continuous_Delivery_Access.adoc b/modules/ROOT/pages/Continuous_Delivery_Access.adoc deleted file mode 100644 index c42cb4f..0000000 --- a/modules/ROOT/pages/Continuous_Delivery_Access.adoc +++ /dev/null @@ -1,24 +0,0 @@ -= Accessing the Bonita Cloud Continuous Delivery Service - -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:CD_LoginPage.png[,70%] - - -== Home page - -You land to this page: - -image:CD_LogHome.png[,70%] - - -== First Connection - -Please start by configuring your xref:Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc[Continuous Delivery Service] - -CAUTION: We strongly recommend that you xref:Continuous_Delivery_Generic_Actions_ChangePWD.adoc[change your password]. - diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 04cb307..0d4674f 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -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] diff --git a/modules/ROOT/pages/Retrieve_Bonita_runtime_logs.adoc b/modules/ROOT/pages/retrieve-bonita-runtime-logs.adoc similarity index 79% rename from modules/ROOT/pages/Retrieve_Bonita_runtime_logs.adoc rename to modules/ROOT/pages/retrieve-bonita-runtime-logs.adoc index e422df6..721b50e 100644 --- a/modules/ROOT/pages/Retrieve_Bonita_runtime_logs.adoc +++ b/modules/ROOT/pages/retrieve-bonita-runtime-logs.adoc @@ -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 @@ -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[] diff --git a/modules/ROOT/taxonomy.adoc b/modules/ROOT/taxonomy.adoc index 2d01611..fe4f881 100644 --- a/modules/ROOT/taxonomy.adoc +++ b/modules/ROOT/taxonomy.adoc @@ -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] diff --git a/modules/ROOT/images/AccessJobDetails.png b/modules/continuous-delivery/images/access-job-details.png similarity index 100% rename from modules/ROOT/images/AccessJobDetails.png rename to modules/continuous-delivery/images/access-job-details.png diff --git a/modules/ROOT/images/AccessParameters.png b/modules/continuous-delivery/images/access-parameters.png similarity index 100% rename from modules/ROOT/images/AccessParameters.png rename to modules/continuous-delivery/images/access-parameters.png diff --git a/modules/ROOT/images/BuildClickToAccessOverview.png b/modules/continuous-delivery/images/build-click-to-access-overview.png similarity index 100% rename from modules/ROOT/images/BuildClickToAccessOverview.png rename to modules/continuous-delivery/images/build-click-to-access-overview.png diff --git a/modules/ROOT/images/BuildDefaultParameters.png b/modules/continuous-delivery/images/build-default-parameters.png similarity index 100% rename from modules/ROOT/images/BuildDefaultParameters.png rename to modules/continuous-delivery/images/build-default-parameters.png diff --git a/modules/ROOT/images/BuildDeployJob.png b/modules/continuous-delivery/images/build-deploy-job.png similarity index 100% rename from modules/ROOT/images/BuildDeployJob.png rename to modules/continuous-delivery/images/build-deploy-job.png diff --git a/modules/ROOT/images/BuildInProgress.png b/modules/continuous-delivery/images/build-in-progress.png similarity index 100% rename from modules/ROOT/images/BuildInProgress.png rename to modules/continuous-delivery/images/build-in-progress.png diff --git a/modules/ROOT/images/BuildJob.png b/modules/continuous-delivery/images/build-job.png similarity index 100% rename from modules/ROOT/images/BuildJob.png rename to modules/continuous-delivery/images/build-job.png diff --git a/modules/ROOT/images/ConfigurationTab.png b/modules/continuous-delivery/images/configuration-tab.png similarity index 100% rename from modules/ROOT/images/ConfigurationTab.png rename to modules/continuous-delivery/images/configuration-tab.png diff --git a/modules/ROOT/images/ConfigureEntryPoint.png b/modules/continuous-delivery/images/configure-entrypoint.png similarity index 100% rename from modules/ROOT/images/ConfigureEntryPoint.png rename to modules/continuous-delivery/images/configure-entrypoint.png diff --git a/modules/ROOT/images/ConfigureMavenJobResult.png b/modules/continuous-delivery/images/configure-maven-job-result.png similarity index 100% rename from modules/ROOT/images/ConfigureMavenJobResult.png rename to modules/continuous-delivery/images/configure-maven-job-result.png diff --git a/modules/ROOT/images/ConsoleOutputAction.png b/modules/continuous-delivery/images/console-output-action.png similarity index 100% rename from modules/ROOT/images/ConsoleOutputAction.png rename to modules/continuous-delivery/images/console-output-action.png diff --git a/modules/ROOT/images/ConsoleOutputEx.gif b/modules/continuous-delivery/images/console-output-ex.gif similarity index 100% rename from modules/ROOT/images/ConsoleOutputEx.gif rename to modules/continuous-delivery/images/console-output-ex.gif diff --git a/modules/ROOT/images/CredentialsJobResult.png b/modules/continuous-delivery/images/credentials-job-result.png similarity index 100% rename from modules/ROOT/images/CredentialsJobResult.png rename to modules/continuous-delivery/images/credentials-job-result.png diff --git a/modules/ROOT/images/DefBuildJobResult.png b/modules/continuous-delivery/images/def-build-job-result.png similarity index 100% rename from modules/ROOT/images/DefBuildJobResult.png rename to modules/continuous-delivery/images/def-build-job-result.png diff --git a/modules/ROOT/images/DefDeployJobResult.png b/modules/continuous-delivery/images/def-deploy-job-result.png similarity index 100% rename from modules/ROOT/images/DefDeployJobResult.png rename to modules/continuous-delivery/images/def-deploy-job-result.png diff --git a/modules/ROOT/images/DeployJob.png b/modules/continuous-delivery/images/deploy-job.png similarity index 100% rename from modules/ROOT/images/DeployJob.png rename to modules/continuous-delivery/images/deploy-job.png diff --git a/modules/ROOT/images/DeployProdJob.png b/modules/continuous-delivery/images/deploy-prod-job.png similarity index 100% rename from modules/ROOT/images/DeployProdJob.png rename to modules/continuous-delivery/images/deploy-prod-job.png diff --git a/modules/ROOT/images/DisplayParametersExample.png b/modules/continuous-delivery/images/display-parameters-example.png similarity index 100% rename from modules/ROOT/images/DisplayParametersExample.png rename to modules/continuous-delivery/images/display-parameters-example.png diff --git a/modules/ROOT/images/JenkinsPlayButton.png b/modules/continuous-delivery/images/jenkins-play-button.png similarity index 100% rename from modules/ROOT/images/JenkinsPlayButton.png rename to modules/continuous-delivery/images/jenkins-play-button.png diff --git a/modules/ROOT/images/Job158FailedLogsDetails.png b/modules/continuous-delivery/images/job-158-failed-logs-details.png similarity index 100% rename from modules/ROOT/images/Job158FailedLogsDetails.png rename to modules/continuous-delivery/images/job-158-failed-logs-details.png diff --git a/modules/ROOT/images/Job158FailedLogs.png b/modules/continuous-delivery/images/job-158-failed-logs.png similarity index 100% rename from modules/ROOT/images/Job158FailedLogs.png rename to modules/continuous-delivery/images/job-158-failed-logs.png diff --git a/modules/ROOT/images/Job158Failed.png b/modules/continuous-delivery/images/job-158-failed.png similarity index 100% rename from modules/ROOT/images/Job158Failed.png rename to modules/continuous-delivery/images/job-158-failed.png diff --git a/modules/ROOT/images/JobDetails.png b/modules/continuous-delivery/images/job-details.png similarity index 100% rename from modules/ROOT/images/JobDetails.png rename to modules/continuous-delivery/images/job-details.png diff --git a/modules/ROOT/images/JobStatusFailed.png b/modules/continuous-delivery/images/job-status-failed.png similarity index 100% rename from modules/ROOT/images/JobStatusFailed.png rename to modules/continuous-delivery/images/job-status-failed.png diff --git a/modules/ROOT/images/JobStatusInProgress.png b/modules/continuous-delivery/images/job-status-in-progress.png similarity index 100% rename from modules/ROOT/images/JobStatusInProgress.png rename to modules/continuous-delivery/images/job-status-in-progress.png diff --git a/modules/ROOT/images/JobStatusLast.png b/modules/continuous-delivery/images/job-status-last.png similarity index 100% rename from modules/ROOT/images/JobStatusLast.png rename to modules/continuous-delivery/images/job-status-last.png diff --git a/modules/ROOT/images/JobStatusOK.png b/modules/continuous-delivery/images/job-status-ok.png similarity index 100% rename from modules/ROOT/images/JobStatusOK.png rename to modules/continuous-delivery/images/job-status-ok.png diff --git a/modules/ROOT/images/LinkToPortal.png b/modules/continuous-delivery/images/link-to-portal.png similarity index 100% rename from modules/ROOT/images/LinkToPortal.png rename to modules/continuous-delivery/images/link-to-portal.png diff --git a/modules/ROOT/images/CD_LogHome.png b/modules/continuous-delivery/images/login-home.png similarity index 100% rename from modules/ROOT/images/CD_LogHome.png rename to modules/continuous-delivery/images/login-home.png diff --git a/modules/ROOT/images/CD_LoginPage.png b/modules/continuous-delivery/images/login-page.png similarity index 100% rename from modules/ROOT/images/CD_LoginPage.png rename to modules/continuous-delivery/images/login-page.png diff --git a/modules/ROOT/images/NewPWD.png b/modules/continuous-delivery/images/new-password.png similarity index 100% rename from modules/ROOT/images/NewPWD.png rename to modules/continuous-delivery/images/new-password.png diff --git a/modules/ROOT/images/NonProdBuildFormDeployDescriptor.png b/modules/continuous-delivery/images/non-prod-build-form-deploy-descriptor.png similarity index 100% rename from modules/ROOT/images/NonProdBuildFormDeployDescriptor.png rename to modules/continuous-delivery/images/non-prod-build-form-deploy-descriptor.png diff --git a/modules/ROOT/images/NonProdBuildForm.png b/modules/continuous-delivery/images/non-prod-build-form.png similarity index 100% rename from modules/ROOT/images/NonProdBuildForm.png rename to modules/continuous-delivery/images/non-prod-build-form.png diff --git a/modules/ROOT/images/OpenAJob.gif b/modules/continuous-delivery/images/open-a-job.gif similarity index 100% rename from modules/ROOT/images/OpenAJob.gif rename to modules/continuous-delivery/images/open-a-job.gif diff --git a/modules/ROOT/images/OpenJobInstance.png b/modules/continuous-delivery/images/open-job-instance.png similarity index 100% rename from modules/ROOT/images/OpenJobInstance.png rename to modules/continuous-delivery/images/open-job-instance.png diff --git a/modules/ROOT/images/OpenUserSetup.png b/modules/continuous-delivery/images/open-user-setup.png similarity index 100% rename from modules/ROOT/images/OpenUserSetup.png rename to modules/continuous-delivery/images/open-user-setup.png diff --git a/modules/ROOT/images/OverviewArtefacts.png b/modules/continuous-delivery/images/overview-artefacts.png similarity index 100% rename from modules/ROOT/images/OverviewArtefacts.png rename to modules/continuous-delivery/images/overview-artefacts.png diff --git a/modules/ROOT/images/BonitaCloud_CD_Overview.png b/modules/continuous-delivery/images/overview.png similarity index 100% rename from modules/ROOT/images/BonitaCloud_CD_Overview.png rename to modules/continuous-delivery/images/overview.png diff --git a/modules/ROOT/images/ProdBuildFormDeployDescriptor.png b/modules/continuous-delivery/images/prod-build-form-deploy-descriptor.png similarity index 100% rename from modules/ROOT/images/ProdBuildFormDeployDescriptor.png rename to modules/continuous-delivery/images/prod-build-form-deploy-descriptor.png diff --git a/modules/ROOT/images/ProdBuildForm.png b/modules/continuous-delivery/images/prod-build-form.png similarity index 100% rename from modules/ROOT/images/ProdBuildForm.png rename to modules/continuous-delivery/images/prod-build-form.png diff --git a/modules/ROOT/images/ReplayAJobInstance.gif b/modules/continuous-delivery/images/replay-a-job-instance.gif similarity index 100% rename from modules/ROOT/images/ReplayAJobInstance.gif rename to modules/continuous-delivery/images/replay-a-job-instance.gif diff --git a/modules/ROOT/images/ReplayAJob.png b/modules/continuous-delivery/images/replay-a-job.png similarity index 100% rename from modules/ROOT/images/ReplayAJob.png rename to modules/continuous-delivery/images/replay-a-job.png diff --git a/modules/continuous-delivery/pages/access.adoc b/modules/continuous-delivery/pages/access.adoc new file mode 100644 index 0000000..30c2e68 --- /dev/null +++ b/modules/continuous-delivery/pages/access.adoc @@ -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]. + diff --git a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_ChangePWD.adoc b/modules/continuous-delivery/pages/basic-actions/change-password.adoc similarity index 58% rename from modules/ROOT/pages/Continuous_Delivery_Generic_Actions_ChangePWD.adoc rename to modules/continuous-delivery/pages/basic-actions/change-password.adoc index 5821a78..f86ee11 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_ChangePWD.adoc +++ b/modules/continuous-delivery/pages/basic-actions/change-password.adoc @@ -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 diff --git a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Parameters.adoc b/modules/continuous-delivery/pages/basic-actions/check-parameters.adoc similarity index 54% rename from modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Parameters.adoc rename to modules/continuous-delivery/pages/basic-actions/check-parameters.adoc index 6fffcdd..e616c9f 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Parameters.adoc +++ b/modules/continuous-delivery/pages/basic-actions/check-parameters.adoc @@ -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[] diff --git a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Monitoring.adoc b/modules/continuous-delivery/pages/basic-actions/monitoring.adoc similarity index 55% rename from modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Monitoring.adoc rename to modules/continuous-delivery/pages/basic-actions/monitoring.adoc index 1d328ef..6656464 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Monitoring.adoc +++ b/modules/continuous-delivery/pages/basic-actions/monitoring.adoc @@ -1,16 +1,18 @@ = 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 @@ -18,16 +20,16 @@ You can check the different actions and logs done in a job through the "console . 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%] diff --git a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Replay.adoc b/modules/continuous-delivery/pages/basic-actions/replay.adoc similarity index 50% rename from modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Replay.adoc rename to modules/continuous-delivery/pages/basic-actions/replay.adoc index e16fe34..bb6df8e 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Generic_Actions_Replay.adoc +++ b/modules/continuous-delivery/pages/basic-actions/replay.adoc @@ -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[] diff --git a/modules/ROOT/pages/Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc b/modules/continuous-delivery/pages/configuring-the-platform.adoc similarity index 72% rename from modules/ROOT/pages/Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc rename to modules/continuous-delivery/pages/configuring-the-platform.adoc index 29f8726..3365cdb 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc +++ b/modules/continuous-delivery/pages/configuring-the-platform.adoc @@ -1,21 +1,25 @@ = 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. @@ -23,12 +27,12 @@ CAUTION: If your Git repository is hosted on GitHub.com, beginning August 13, 20 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. @@ -38,15 +42,15 @@ 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 @@ -54,7 +58,7 @@ This job allows you to define the default build parameters i.e. the BCD Configur 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. + @@ -62,6 +66,6 @@ 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] diff --git a/modules/ROOT/pages/Continuous_Delivery_Build_and_deploy.adoc b/modules/continuous-delivery/pages/living-application/build-and-deploy.adoc similarity index 72% rename from modules/ROOT/pages/Continuous_Delivery_Build_and_deploy.adoc rename to modules/continuous-delivery/pages/living-application/build-and-deploy.adoc index 18f9984..65b5c26 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Build_and_deploy.adoc +++ b/modules/continuous-delivery/pages/living-application/build-and-deploy.adoc @@ -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] @@ -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 diff --git a/modules/ROOT/pages/Continuous_Delivery_Building_a_Living_Application.adoc b/modules/continuous-delivery/pages/living-application/build.adoc similarity index 72% rename from modules/ROOT/pages/Continuous_Delivery_Building_a_Living_Application.adoc rename to modules/continuous-delivery/pages/living-application/build.adoc index 58dfa48..1adab88 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Building_a_Living_Application.adoc +++ b/modules/continuous-delivery/pages/living-application/build.adoc @@ -1,19 +1,21 @@ = Building a Living Application +:description: Describes the job to build a living application from Jenkins +:page-aliases: ROOT:Continuous_Delivery_Building_a_Living_Application.adoc == Build Job The job "ACTION - Build a LivingApp" allows you to build your living applications: -image:BuildJob.png[] +image:build-job.png[] == Launching a build -. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "ACTION - Build a LivingApp" job. +. Click on the image:jenkins-play-button.png[CDPlayButton] of the "ACTION - Build a LivingApp" job. . Your default build configuration will be pre-loaded. If needed you can change it (includes the repository URL and branch) . Click on the build button (lower left). . You should see the job progress and steps. -image:BuildInProgress.png[] +image:build-in-progress.png[] == Result of a build @@ -29,11 +31,11 @@ WARNING: if your last job fails, it will still display the last successful artif + ** Open the job by clicking on its title + -image:BuildClickToAccessOverview.png[] +image:build-click-to-access-overview.png[] + ** In the top of the page, you will find the last successful build artifacts + -image:OverviewArtefacts.png[] +image:overview-artefacts.png[] + * Job instance detail + @@ -41,11 +43,11 @@ NOTE: This also allows you to consult previous build result + ** Open the specific job instance by click on its ID + -image:AccessJobDetails.png[] +image:access-job-details.png[] + ** You can now consult the result of that job instance: + -image:JobDetails.png[] +image:job-details.png[] === Failed Build @@ -55,12 +57,12 @@ If the job fails then you need to open its logs to understand the issues. The below build job has failed -image:Job158Failed.png[] +image:job-158-failed.png[] To get more information on the issue, click on the step that failed and information on the error will be displayed: -image:Job158FailedLogs.png[] +image:job-158-failed-logs.png[] If this isn't enough then you can click on the "Logs" button to have the full logs: -image:Job158FailedLogsDetails.png[] +image:job-158-failed-logs-details.png[] diff --git a/modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc b/modules/continuous-delivery/pages/living-application/deploy-in-prod-with-bonita-cloud.adoc similarity index 77% rename from modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc rename to modules/continuous-delivery/pages/living-application/deploy-in-prod-with-bonita-cloud.adoc index 143ab62..f835a0a 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc +++ b/modules/continuous-delivery/pages/living-application/deploy-in-prod-with-bonita-cloud.adoc @@ -1,16 +1,18 @@ = Deploying a Living Application to Bonita Cloud Production Runtimes +:description: Learn how to deploy a living application to Bonita Cloud Production Runtimes +:page-aliases: ROOT:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud_Prod.adoc == Deploy Job The job "ACTION - Deploy a LivingApp to a production runtime" allows to you deploy your living applications to any of your *production* Bonita Cloud runtimes: -image:DeployProdJob.png[] +image:deploy-prod-job.png[] -image:ProdBuildForm.png[] +image:prod-build-form.png[] == Launching a deployment -. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "ACTION - Deploy a LivingApp to a production runtime" job. +. Click on the image:jenkins-play-button.png[CDPlayButton] of the "ACTION - Deploy a LivingApp to a production runtime" job. . Your default deploy configuration will be pre-loaded. If needed you can change it. . You still need to select the build you want to deploy. You have several possibilities: @@ -23,7 +25,7 @@ You have several possibilities: ** Last completed build ** Specified by permalink ** Copy from WORKSPACE of the latest completed build -. Select the target runtime (note that only production runtimes are available - to deploy on non-production runtimes see xref:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc[here]) +. Select the target runtime (note that only production runtimes are available - to deploy on non-production runtimes see xref:living-application/deploying-to-bonita-cloud.adoc[here]) . For troubleshooting purposes, you can activate the "Debug_mode" option to activate the debug verbose mode. . Click on the build button (lower left). . You should see the job progress and steps. @@ -59,7 +61,7 @@ When used, if a deploy policy is declared in DEPLOY_JSON, it overrides the Produ To use the deployment descriptor, enter the content of the deploy.json in the `DEPLOY_JSON` optional field. -image:ProdBuildFormDeployDescriptor.png[] +image:prod-build-form-deploy-descriptor.png[] == Result of a deployment @@ -67,4 +69,4 @@ image:ProdBuildFormDeployDescriptor.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[] +image:link-to-portal.png[] diff --git a/modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc b/modules/continuous-delivery/pages/living-application/deploying-to-bonita-cloud.adoc similarity index 76% rename from modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc rename to modules/continuous-delivery/pages/living-application/deploying-to-bonita-cloud.adoc index 1d456a4..b562014 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc +++ b/modules/continuous-delivery/pages/living-application/deploying-to-bonita-cloud.adoc @@ -1,16 +1,18 @@ = Deploying a Living Application to Bonita Cloud Non Production Runtimes +:description: Lear how to deploy a living application to Bonita Cloud Non Production Runtimes +:page-aliases: ROOT:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc == Deploy Job The job "ACTION - Deploy a LivingApp to a non-production runtime" allows you to deploy your living applications to any of your Bonita Cloud runtimes with the development or production policies: -image:DeployJob.png[] +image:deploy-job.png[] -image:NonProdBuildForm.png[] +image:non-prod-build-form.png[] == Launching a deployment -. Click on the image:JenkinsPlayButton.png[CDPlayButton] of the "ACTION - Deploy a LivingApp to a non-production runtime" job. +. Click on the image:jenkins-play-button.png[CDPlayButton] of the "ACTION - Deploy a LivingApp to a non-production runtime" job. . Your default deploy configuration will be pre-loaded. If needed you can change it. . You still need to select the build you want to deploy. You have several possibilities: @@ -23,8 +25,8 @@ You have several possibilities: ** Last completed build ** Specified by permalink ** Copy from WORKSPACE of the latest completed build -. 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]) -. 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. +. Select the target runtime (note that only non-production runtimes are available - to deploy in production see xref:living-application/deploy-in-prod-with-bonita-cloud.adoc[here]) +. 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 xref:{bcdVersion}@bcd:ROOT:deployer.adoc#preconfigured_deployment_policies[the deployment policies] to apply. + [NOTE] @@ -63,7 +65,7 @@ When used, if a deploy policy is declared in DEPLOY_JSON, it overrides the other To use the deployment descriptor, enter the content of the deploy.json in the `DEPLOY_JSON` optional field. -image:NonProdBuildFormDeployDescriptor.png[] +image:non-prod-build-form-deploy-descriptor.png[] == Result of a deployment @@ -71,7 +73,7 @@ image:NonProdBuildFormDeployDescriptor.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 diff --git a/modules/ROOT/pages/Continuous_Delivery_Managing_Living_Application_configuration.adoc b/modules/continuous-delivery/pages/living-application/manage-configuration.adoc similarity index 56% rename from modules/ROOT/pages/Continuous_Delivery_Managing_Living_Application_configuration.adoc rename to modules/continuous-delivery/pages/living-application/manage-configuration.adoc index 6b7eb84..68a3043 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Managing_Living_Application_configuration.adoc +++ b/modules/continuous-delivery/pages/living-application/manage-configuration.adoc @@ -1,6 +1,8 @@ = Managing Living Application configuration +:description: Explain how to manage a Living application. +:page-aliases: ROOT:Continuous_Delivery_Managing_Living_Application_configuration.adoc -The parameters will come from the LIVINGAPP_ENVIRONMENT_NAME you choose to perform your action. It's the name of the process configuration environment as defined in Bonita Studio (Integration, Qualification, Production...) +The parameters will come from the `LIVINGAPP_ENVIRONMENT_NAME` you choose to perform your action. It's the name of the process configuration environment as defined in Bonita Studio (Integration, Qualification, Production...) Then you may want to override some of them using a specific configuration. @@ -10,4 +12,4 @@ Into that directory you are able to store encrypted parameters files using this CAUTION: Ensure to encrypt your parameters file before pushing them on your repository. See the https://docs.ansible.com/ansible/latest/user_guide/vault.html[Ansible Vault documentation] to do so. We also recommend to use private repositories. -A mandatory step to run your jobs is to configure your vault password as described into xref:Continuous_Delivery_Configuring_your_Continuous_Delivery_Platform.adoc#_repository_credentials[Repository Credentials] +A mandatory step to run your jobs is to configure your vault password as described into xref:continuous-delivery:configuring-the-platform.adoc#repository_credentials[Repository Credentials] diff --git a/modules/ROOT/pages/Continuous_Delivery_Test_a_Living_Application.adoc b/modules/continuous-delivery/pages/living-application/test-a-living-application.adoc similarity index 64% rename from modules/ROOT/pages/Continuous_Delivery_Test_a_Living_Application.adoc rename to modules/continuous-delivery/pages/living-application/test-a-living-application.adoc index 119f6f0..1de9ff0 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Test_a_Living_Application.adoc +++ b/modules/continuous-delivery/pages/living-application/test-a-living-application.adoc @@ -1,4 +1,7 @@ = Test a living application on Non Production Runtimes +:description: Learn how to test a living application on Non Production Runtimes +:page-aliases: ROOT:Continuous_Delivery_Test_a_Living_Application.adoc + [NOTE] ==== @@ -13,4 +16,4 @@ It requires to include a subfolder in your Bonita project within the same git re Then create your integration tests following the xref:test-toolkit:ROOT:quick-start.adoc#quick-start-test[Test Toolkit documentation]. -You will be able to launch your integrations tests by specifying into xref:Continuous_Delivery_Deploying_a_Living_Application_to_Bonita_Cloud.adoc[deploy] or xref:Continuous_Delivery_Build_and_deploy.adoc[build and deploy] jobs the folder where you have stored your tests through the INTEGRATION_TESTS_DIR parameter. +You will be able to launch your integrations tests by specifying into xref:living-application/deploying-to-bonita-cloud.adoc[deploy] or xref:living-application/build-and-deploy.adoc[build and deploy] jobs the folder where you have stored your tests through the INTEGRATION_TESTS_DIR parameter. diff --git a/modules/ROOT/pages/Continuous_Delivery_Overview.adoc b/modules/continuous-delivery/pages/overview.adoc similarity index 62% rename from modules/ROOT/pages/Continuous_Delivery_Overview.adoc rename to modules/continuous-delivery/pages/overview.adoc index 490cf67..53ab978 100644 --- a/modules/ROOT/pages/Continuous_Delivery_Overview.adoc +++ b/modules/continuous-delivery/pages/overview.adoc @@ -1,5 +1,9 @@ = Bonita Cloud Continuous Delivery +:description: Overview of bonita cloud continuous delivery +:page-aliases: ROOT:Continuous_Delivery_Overview.adoc + + NOTE: Bonita Cloud includes a ready to use continuous delivery platform to allow you to *build* and *deploy* projects in a few clicks in order to test, validate and fast track changes -image:BonitaCloud_CD_Overview.png[] +image:overview.png[]