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

Configure universal access to the plugins directory

3 minute readReferenceExtensibility

A plugin is a collection of one or more features, third-party integrations, or tools that can be added to CloudBees CD/RO. The CloudBees CD/RO server installs all plugins into a configurable plugins directory (Administration  Server settings  System settings  Plugins directory).

To share the plugin directory, it must be readable by the web server. There are two ways to make the plugins directory readable by the web server, by either:

Setting up shared filesystems for the plugins directory

This section explains how your plugins directories can be shared in several CloudBees CD/RO configurations to promote high availability. These configurations include:

The information below applies to traditional installations of CloudBees CD/RO only. For Kubernetes installations, shared plugin are handled in the server Helm chart by sharedPluginsEnabled: true. However, you must have shared storage configured with adequate values for your shared plugins. For more information, refer to Kubernetes cluster and storage requirements.

Plugin directory for non-clustered deployments

If your CloudBees CD/RO server is:

  • Not clustered,

  • Using its local plugins directory configured in Administration  Server settings  System settings  Plugins directory, and

  • All required components have at least read access to the configured plugin directory,

it is not necessary to make any changes. This is the default location (DATA_DIR/plugins) used by the CloudBees CD/RO server when plugins are installed.

Plugin directory for clustered deployments

If your CloudBees CD/RO server is clustered, you can set the plugin directory with the CloudBees CD/RO UI or CLI:

  • To add your plugin directory using the UI, navigate to Administration  Server settings  System settings and configure the Plugins directory field.

  • To add your plugin directory using the CLI, run:

    ectool setProperty /server/settings/pluginsDirectory /mymountpoint/plugins
    ▼

Ensure all require components have at least read access to the configured plugin directory. For more information, refer to Sharing network plugins between servers and web servers.

Sharing network plugins between servers and web servers

If you want your local or remote web server to use the same network plugins share as the CloudBees CD/RO server, follow the instructions below for your CloudBees CD/RO web server(s) to update DATA_DIR/apache/conf/httpd.conf.

Linux web servers

If you are using Linux CloudBees CD/RO web servers, you can directly mount the network plugins share to the DATA_DIR/plugins directory. If this is not an option, to set the plugins directory:

On Linux, changes to the CloudBees CD/RO web server using ecconfigure should be run using sudo privileges, which trigger a web server restart automatically. However, if the commands are not run with sudo privileges, or you have --skipServiceRestart configured, you must restart each CloudBees CD/RO web server where you use these commands.

  1. Run:

    ecconfigure --webPluginsDirectory PLUGINS_SHARE_FOLDER
    ▼

    For example:

    ecconfigure --webPluginsDirectory /mymountpoint/plugins
    ▼

  2. Ensure your web server is restarted. To manually restart your web server, run:

    • For root users, run

      /etc/init.d/commanderApache restart
      ▼

    • If you are using systemd, run

      sudo systemctl reload-or-restart commanderApache
      ▼

Windows web servers

If you are using CloudBees CD/RO web servers are on Windows, you must use the UNC path for your plugin directory. To set the plugin directory:

  1. Run:

    ecconfigure --webPluginsDirectory \\servername\path
    ▼

    For example:

    ecconfigure --webPluginsDirectory \\f2\scratch\chronic3plugins
    ▼

  2. Ensure your CloudBees CD/RO web server is restarted.

Replicating the plugin directory on remote systems

Use this procedure to keep the plugins directory in its default server location and replicate the contents to web servers.

This approach requires you to manage multiple plugin directories. Every time a new plugin is installed on the CloudBees CD/RO server, you must synchronize the changes across all remote copies of the directory. Only replicate the plugins directory if you cannot use or configure a central network location.

To implement this method, you must:

  1. Navigate to Administration  Server settings  System settings and configure the Plugins directory field.

  2. Using any file copy mechanism, copy the configured plugins directory into a plugins subdirectory of the data directory for your remote web server(s).

  3. Ensure the copied plugins directories is readable by only the remote web server(s).

  4. Every time the CloudBees CD/RO server plugins directory is updated, you must synchronize the changes across all remote copies.

Configure autostart for non-root/non-sudo Linux installations
Configure an environment proxy server