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

Back up a CloudBees CD/RO server

3 minute readReference

You should back up your existing CloudBees CD/RO data frequently. CloudBees recommends full regular (nightly) database backups and database backups before an upgrade.

Data backup methods

There are two ways to back up your data. You can use a database-specific backup tool to create a database dump, or you can use the CloudBees CD/RO ectool export tool to create a complete XML database backup. This section describes the differences between the two types of backups.

CloudBees recommends that you do not use the ectool export tool with jobs on an active system to create a trusted database backup.

Database dumps

You must use a database-specific backup tool to create a database dump. Database dumps have the following characteristics:

  • The backup process takes much less time to complete than full XML exports

  • Database dumps (for example MySQL) must be performed while the database is live, up, and running.

  • You can quickly restore a database from a database dump.

A database dump can only be restored to the same type of database. If you are planning to switch your database type when you restore from the backup, you must create an XML backup.

Complete XML database backup

You must use the ectool export tool to create a complete XML database backup. Complete XML database backups have the following characteristics:

  • The tool must be used while the CloudBees CD/RO server is running.

  • The database backup process can take considerably longer than simply creating a database dump, but this method is necessary in the following situations:

  • Backing up the database is not an available option.

  • You need to migrate from one type of database to another. For example, MySQL to Oracle.

  • You want a full export in a text form you can search with an editor.

It might not be feasible to run a full XML export regularly (such as nightly). So if jobs are running, best practice to speed up the full export (and to help prevent issues with importing the data later) is to use the --excludeJobs option. For more information about the ectool export command, refer to Use the CloudBees CD/RO Perl API.

Preparing for a backup

Before you back up your CloudBees CD/RO server:

  • Make sure you have plenty of free space available because full database dumps and XML export files can be extremely large.

  • Compress database dumps if they are not compressed by default.

  • Regularly perform maintenance such as, but not limited to:

    • Pruning job workspaces

    • Deleting or compressing CloudBees CD/RO log files

    • Deleting unused projects and/or procedures

You can use CloudBees CD/RO to perform backups by creating a procedure that runs the database dump or export command.

Backing Up a CloudBees CD/RO Server

Use the following procedure to back up your CloudBees CD/RO server data. Review Preparing for a Backup before performing this procedure.

  1. Choose one of the following methods to back up your data:

    • Use a database-specific backup tool to create a database dump.

    • Use ectool export to create a complete XML database backup.

      For more information about database backup methods, refer to Data Backup Methods.

  2. Save the passkey file. The full path name of this file is:

    • Linux: /opt/cloudbees/sda/conf/passkey

    • Windows: C:\ProgramData\CloudBees\Software Delivery Automation\conf\passkey

      When you restore your server, this passkey must be in place so CloudBees CD/RO can decrypt passwords for user impersonation, LDAP, and the database connection.

  3. Back up the plugins directory.

    • The plugins directory is stored in a server setting property (/server/settings/pluginsDirectory).

    • If the property does not exist, the server uses the default location, which is the plugins subdirectory in the data directory.

  4. Back up the files containing your custom configurations and settings to ensure all important settings are saved.

    • The default location for CloudBees CD/RO server and agent configuration files is the conf subdirectory in the data directory.

    • The default location for the Apache web server configuration files is the apache/conf subdirectory in the data directory.

  5. Verify that your backup contains the following items:

    • Database dump and/or XML export

    • The passkey file

    • The contents of the plugins directory

    • Configuration files

    • Keystores

Restore a CloudBees CD/RO server