Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsConfigure IP protocols for Helm chart componentsConfigure GitOps with Helm chartsVerify Helm chartsCreate custom Docker imagesVerify Docker images
IntroductionInstallation user requirementsInstallation typesDefault installation directoriesVerify installation binariesAgent security recommendations
IntroductionInstall a default configurationInstall a custom configurationRun an express agent GUI installationRun an express GUI installation (agent-only installer)Run an advanced GUI installation (agent-only installer)Install CloudBees Analytics
IntroductionRun an express server command-line installationRun an advanced command-line installationRun an express agent command-line installationExpress agent command-line installation (agent-only installer)Advanced command-line installation (agent-only installer)Install the CloudBees Analytics server with the interactive command-line installer
IntroductionRun a silent installationSilent installation argumentsLinux silent installation examplesWindows silent installation examplesCloudBees Analytics server unattended installation
IntroductionUNIX agent interactive command-line installationSilent installation method for UNIX or macOS agents
IntroductionPrerequisitesPermissions to install or upgrade remote agentsInstall remote agents using the web interfaceInstall via the API
CloudBees Tools installation
Move the artifact repository in LinuxMove the artifact repository in Windows
Connect CloudBees CD/RO to a Microsoft SQL server
Install the MySQL JDBC connector
IntroductionUninstall CloudBees CD/RO on Linux, Unix, or macOSUninstall on WindowUninstall the CloudBees Analytics server on LinuxUninstall the CloudBees Analytics server on Windows
IntroductionZones and gatewaysConfigure custom CAs and CRLs in non-clustered environmentsConfigure custom CAs and CRLs in clustered environmentsConfigure agent environment variablesLicensesCreate and manage usersEdit user settingsCreate and manage groupsPersonasConfigure an external databaseConfigure CloudBees CD/RO to use an alternate databaseInstall services for non-root/non-sudo Linux installationsConfigure autostart for non-root/non-sudo Linux installationsConfigure universal access to the plugins directoryConfigure an environment proxy serverSystem health monitoringIncrease file descriptors on Linux and Linux Docker containersAdjust swappiness on LinuxSet variables on Windows agent machinesServer propertiesServer settingsSource code synchronization
IntroductionConfigure initial events for Workload InsightsConfigure OpenSearch Dashboards to work with CloudBees Analytics
IntroductionArchitecture of a CloudBees CD/RO clusterResource, agent, and procedure considerationsSoftware for clusteringDependencies for clusteringConfigure clusteringSeparate agents from CloudBees CD/RO serversPrepare your cluster resourcesInstall and configure a load balancerInstall ZooKeeperConfigure a multi-ZooKeeper clusterInstall CloudBees CD/RO softwareConfigure repository serversConfigure machines to operate in clustered modeRun a cluster in single-server modeAdd the configuration to ZooKeeperUpload configuration files to ZooKeeperGet cluster information from ZooKeeperAdd a node to an existing clusterConfigure web server propertiesConfigure repository server propertiesConfigure CloudBees CD/RO agentsConfigure the cluster workspaceConfigure CloudBees CD/RO repositoriesAdd trusted agents to clustersVerify CloudBees CD/RO servicesAccess CloudBees CD/RO with clusteringHealth check for the CloudBees CD/RO clusterAdditional ways to improve a clusterInstall the CloudBees Analytics server in cluster modeUse self-signed certificates in CloudBees CD/RO on KubernetesConfigure Disaster Recovery and recover from a disaster
Sign in to CloudBees CD/ROAccess the Home pageMy work dashboardGuided tutorialsLearn about the object modelSearch and filter
IntroductionIntrinsic properties listed by object typeReserved words in CloudBees CD/ROObject types in CloudBees CD/ROSpecial characters in CloudBees CD/RO object namesContext-relative shortcuts to property pathsProperty error codesConfigure properties or property sheetsProperty BrowserProperty reference use case
IntroductionResource poolsCreate or edit resource pools
IntroductionView workspacesCreate or edit workspacesWorkspace file
IntroductionCreate a projectSchedules
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksUse the CloudBees CD/RO API to define tasksDefine manual tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesNative CI integrationPipeline UIAuthor and run pipelinesDefine stage gate rulesPipeline objects and conditionsPipeline stage summaryCredentials in pipelinesRun pipelinesView pipeline runsExample: Create a manual task in a pipelineExample: Plugin pipeline tasksExample: Integrate test automation in release pipelinesExample: Leverage test data management and service virtualization in release pipelines
IntroductionRelease planning, scheduling, and trackingRelease and environment reservations calendarVisibility and status of release pipelinesRelease definitionDeploy with Argo RolloutsRelease dashboardPlanned versus actual view for pipeline statusPath to production viewRelease summaryRun and end releases
Introduction
IntroductionManage procedure runsProcedure run detailsUsing CloudBees CD/RO in your environmentJob step executionPostprocessors: Collecting data for reports
IntroductionWorkflow listsCreate or edit workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow LogTransition workflow
Introduction
IntroductionCreate and manage applicationsApplication process run detailsCreate application processesAdd process stepsProcess branchingConfigure plugin process stepsDefine manual stepsExample: Manual step with runtime parametersAttach credentials to processesFull-stack dependency viewApplication deployment optionsConfiguration drift
IntroductionMaster component examplesMaster components list
Introduction
IntroductionStage artifactsCapture snapshotsApplication rollbackManage dependencies
IntroductionCreate environmentsDefine environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsLock environmentsModel dynamic environmentsAutomated environment discoveryCreate a deployment task to trigger third-party toolsGenerate a deployment packageExample: Dynamic environment with Amazon and ChefExample: Deploy and troubleshoot applicationsExample: Deploy applications with provisioned cloud resourcesExample: Implement deployment strategies
IntroductionArtifactsArtifact versionsRepositories
Create object tagsCreate object schedules
IntroductionConfigure webhook triggersConfigure polling triggers
IntroductionConfigure email notificationsSelect and edit email messages for application or microservice processes
Introduction
IntroductionInstall CloudBees CD/RO pluginsCreate plugin configurationsManage pluginsCreate pluginsManage the plugin catalog

Guidelines for modeling and deploying applications

5 minute readReferenceAutomation

When modeling applications

Keep the following in mind:

  • By default, change tracking is enabled for all CloudBees CD/RO Deploy projects.

  • When authoring a component process, you specify the process type. The default is Deploy.

    In the Component Process dialog box, select one of these values in the Type field: Deploy –Enables Inventory Tracking. The CloudBees CD/RO server tracks the artifacts deployed to environments. Undeploy —The next time that the process is run, the CloudBees CD/RO server removes information about the artifacts deployed to environments. * *Other –Disables Inventory Tracking.

  • You can also create a library of standardized reusable components to promote best practices across the enterprise and speed up application authoring with master components. This is an easy way to reuse existing definitions and their underlying process definitions. For more information, refer to Master Components.

  • After creating an application, you can version the entire application model by taking a snapshot of it. A snapshot is an immutable version of an application with specific artifact versions.

    You can save more than one snapshot of an application during the software release life cycle. You can compare snapshots to optimize and troubleshoot the application. You can also deploy a snapshot even if the latest version of the application has been modified.

    See Snapshots for more information.

  • You can include hyperlinks as part of an object description for any CloudBees CD/RO object.

  • Known issues:

    • If an application tier has two components that cannot be deployed to the same host, the components need to be in different application tiers.

    • If a formal parameter in a manual process step is renamed, the formal parameter properties are not updated.

  • See Inventory Tracking for more information.

  • Go to Environment Inventory for more information.

  • See Example: Modeling and Deploying Applications for an example of the Application Inventory in the Application View Run page.

When modeling environments

You can optimize how resources are used in application deployments. You can model dynamic environments that are automatically spun up when an application is deployed. These environments can have cloud and static resources. Cloud resources are provisioned using resource templates, which are specified in environment templates.

Using dynamic environments allows you to:

  • Provide ways to optimize how cloud resources are used.

  • Reuse provisioned resource pools.

  • Track how provisioned cloud resources are used.

  • Provide the status of the provisioning process.

  • Verify the credentials of cloud resources before provisioning them.

  • Configure the middleware of cloud resources on an on-demand basis.

When deploying applications

How an application is deployed depends on what you want to deploy. You can select the following deployment options.

  • New run: Specify the runtime parameters and settings in the dialog box.

  • Last run: Use the parameters from a previous run. Modify one or more of these parameters as described in the dialog box where the runtime parameters and settings are set.

    The option does not appear the first time an application is deployed.

  • Schedule: Set the application to run on a schedule as described in Running Applications with Schedules .

You can also deploy the application with these options and methods:

  • Full deploy: CloudBees CD/RO deploys all the objects (including application processes, components, and artifacts) in the application. When you deploy an application for the first time, you must do a full deploy. Use this method whenever you need to verify that the software is ready to be released.

  • Smart deploy: This deployment method reduces risk and time by only deploying changed objects. CloudBees CD/RO automatically detects the differences between what is about to be deployed and what has already deployed to an environment. It deploys only those objects not yet deployed to a specific resource or to resources where the object version is different. You can use this method throughout the software release life cycle.

  • Partial deploy: The system deploys only objects that you select. Use this method to verify incremental changes.

  • Partial deploy with specific artifact versions: The system deploys only the artifacts with selected versions. Use this method to verify incremental changes.

  • Schedule: Create schedules to deploy applications on a one-time, daily, weekly, or monthly basis. Schedule nightly builds so that the developers and quality always have a new version to work on every day.

  • Snapshot: You select a snapshot to deploy. A snapshot is an immutable version of the application with specific artifact versions. You can save and compare snapshots throughout a release life cycle.

    If you select a snapshot and modify it, it is no longer a snapshot and becomes a different version of the application, which you can save as a new snapshot.

  • Based on custom parameters defined in application processes: Set these parameters when you deploy the application or when you define an application process step. They determine how the application should be deployed.

  • Artifact staging: CloudBees CD/RO retrieves the artifacts that will be deployed in an application run before the deployment starts. This ensures that all the artifacts are downloaded and available on the target. It also minimizes the time it takes to retrieve artifacts and reduces downtime during the deployment. Refer to Artifact Staging for more information.

  • Rollback: When an application deployment fails, you can use the rollback functionality to restore the deployment model to a state before the failure occurred. This operation is supported only in application processes. Refer to Rollback for more information.

Deploy applications by combining methods, such as:

  • Smart deploy and partial deploy

  • Smart deploy, artifact staging, and a partial deploy with specific artifact versions

  • Full deploy and artifact staging with a snapshot

  • Smart deploy and artifact staging

  • Artifact staging and partial deploy

For example, this sequence is an example of how you may deploy your software over time:

  • When creating an application in CloudBees CD/RO and deploying it for the first time, you must do a full deploy. By default, smart deploy is disabled the first time that you run an application.

  • Throughout these deployments, you can schedule the deployments to occur on a daily or weekly basis to provide builds that can be tested and installed on a regular basis.

  • Save snapshots of the software at regular intervals or milestones. When troubleshooting the software or performing testing, use one of these snapshots for comparison.

  • If the application does not deploy successfully, redeploy partially to troubleshoot the application or component processes that failed.

    Perform a partial deploy and redeploy the application with only the objects that failed.

    Perform a partial deploy only with specific versions of artifacts to determine if one or more specific versions of artifacts are causing problems.

  • Later, after successfully deploying the application, redeploy parts of the application when new versions of artifacts or new resources are available.

  • When a new version of an artifact is released, deploy only the artifact by selecting the new version and doing a partial deploy.

  • When adding artifacts and resources to the application, deploy the new artifacts to resources and specific versions of selected artifacts to the new resources, a combination of smart deploy and partial deploy with specific artifact versions.

Getting the real-time status of application runs and troubleshooting

Use the Environment Inventory and Application Inventory to view the progress of the application as it runs and the results of previous runs. They show detailed results that can be used to troubleshoot the application. See Inventory Tracking for more information.

  • In the Application Inventory (on the Applications Run View page), obtain information about the application, its application processes, components, and job steps and about the status of these objects.

  • In the Environment Inventory, obtain more details about the environment, the applications mapped to it, number of deployed artifacts in the applications, where the artifacts are deployed, and the status of these objects.

Use Change Tracking to troubleshoot a failed job, look for more information about non-run object, or look for differences between objects. See Change Tracking for more information.

Compare snapshots to refine and troubleshoot an application. See Snapshots for more information.