Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsScale build resources manually using a procedureConfigure 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 configurationInstall an express agent (full installer)Install an express agent (agent-only installer)Install an advanced agent (agent installer)Install CloudBees Analytics
IntroductionInstall a default configurationInstall a custom configurationInstall an express agent (full installer)Express agent command-line installation (agent-only installer)Advanced command-line installation (agent-only installer)Install CloudBees Analytics
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
IntroductionManage service catalogsManage service catalog itemsManage custom filters for catalogs and catalog items
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

UI upgrade method

3 minute readDeveloper productivity

Use this procedure to upgrade CloudBees CD/RO. Review Upgrade a clustered environment or Upgrading a non-clustered environment, as appropriate, before performing this procedure.

When upgrading the nodes in a CloudBees CD/RO cluster, you must keep the other nodes stopped until the primary node upgrade is complete.

Also, after upgrading from CloudBees CD/RO 10.8 or earlier, delete all .old files, such as .properties.old in the conf subdirectory to finish the encryption process.

  1. If you have not already done so, download the full installer file. To download this version, select your required installer:

  2. Start the installer:

    • Windows:

      Windows installers
      On Windows, an Administrator user is required to install CloudBees CD/RO. For more information about required user privileges, refer to Windows services user permissions.

      1. Navigate to the directory where you downloaded the CloudBees CD/RO installer.

      2. Double-click the installer. This starts the installer in the GUI-based installation mode.

    • Linux:

      Linux installers

      1. Navigate to the directory where you downloaded the CloudBees CD/RO installer.

      2. Enter the following command to make the installer file executable:

        Command
        Current version
        chmod +x CloudBeesFlow-x64-<version>
        ▼
        chmod +x CloudBeesFlow-x64-2024.12.0.177508
        ▼

      3. Start the upgrade:

        For more information about required user privileges, refer to Linux services user permissions.

        • For root or sudo upgrades:

          Root or sudo procedures

          1. Navigate to the directory where you downloaded CloudBees CD/RO.

          2. Double-click the installer. This starts the installer in the GUI-based installation mode.

        • For non-root/non-sudo upgrades, from the terminal, run:

          Non-root/non-sudo procedures
          Command
          Current version
          ./CloudBeesFlow-x64-<version> --nonRoot
          ▼
          ./CloudBeesFlow-x64-2024.12.0.177508 --nonRoot
          ▼

          A warning about automatic server start-up with non-root/non- sudo installations appears. Select Yes to dismiss the warning.

  3. Choose one of the following options:

    • Select Upgrade the existing installation if you want to upgrade your current CloudBees CD/RO installation directory.

    • Select Perform a clean install if you want to specify a different installation directory for the new version.

      When selecting Perform a clean install, current CloudBees CD/RO services remain running until you select Next on the Ready to Install screen. This means the new installation cannot use the same ports and directories as the existing installation. To use the same ports and directories, you must manually stop the existing services. This will free the existing ports and directories.

  4. Select Next to upgrade the existing installation. The Ready to upgrade screen appears.

  5. Review the upgrade settings.

    • If needed, use the Back button to change your selections if necessary.

  6. Select Next to continue.

    The installer displays a status bar to show the progress of the upgrade process. You can also view the installer.log file to see progress. The time that it takes to complete this process depends on the size of the database. It may take fifteen minutes or longer to complete. Once this process is complete, the new CloudBees CD/RO version is installed.

  7. Select the Launch a web browser to login to CloudBees CD/RO check box if you want CloudBees CD/RO to open the login screen now.

  8. Click Finish to complete the upgrade.

    When upgrading the CloudBees CD/RO server after the installation is complete, the server continues to upgrade the database (if applicable). You cannot log in to the CloudBees CD/RO server until the database upgrade finishes. You can view the upgrade status by using ectool from a command line:

    ectool getServerStatus
    ▼

    For upgrades involving large databases, the output from ectool getServerStatus might remain unchanged for long periods. In this case, you can view more granular database update activity by following the procedures on KBEC-00086 - Enabling and collecting voluminous JDBC logging to add SQL logging to the <data_dir>/logs/commander.log file. You can view recent SQL logging updates to the file by using the Linux tail <data_dir>/logs/commander.log command.

After selecting Finish, the CloudBees CD/RO web page opens. However, until the complete upgrade is finished, you will not be able to log in.

You will be able to view the components being installed while the installation completes. You can periodically refresh the page to view the updated status. Once it is complete, the log in window appears.
Upgrade a clustered environment
Interactive command-line upgrade method