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 an environment proxy server

2 minute readReference

In your environment, proxy servers might exist between an intranet and internet. Because proxy servers can inhibit certain types of internet access, you may need to set proxy settings for each impacted machine in your installation. CloudBees CD/RO servers, web servers, and agents can be deployed behind a proxy server.

It is not a common practice to place repository servers or agent systems behind a proxy server since these systems communicate with CloudBees CD/RO through an intranet connection.

Configuring proxy settings for servers

CloudBees CD/RO Agent supports basic authentication only for an external proxy server.

Web server

ecconfigure --webProxyUrl https://<IP_ADDRESS:PORT> \
        --webNoProxyHosts <HOST1,HOST2,HOST3>
▼

Servers and agents

  1. Stop all servers and agents. See Starting and Stopping Servers and Agents Manually.

  2. On all agent systems, set the server IP address as documented in Configuring CloudBees CD/RO agents.

  3. Configure proxy settings on the CloudBees CD/RO server, all servers that participate in a cluster, and all agents in the components corresponding configuration file.

    When you use a proxy agent, the proxy target must run an SSH v2 server.

    • Servers:

      • Linux: /opt/cloudbees/sda/conf/wrapper.conf

      • Windows: C:\ProgramData\CloudBees\Software Delivery Automation\conf\wrapper.conf

    • Agents:

      • Linux: /opt/cloudbees/sda/conf/agent/wrapper.conf

      • Windows: C:\ProgramData\CloudBees\Software Delivery Automation\conf\agent\wrapper.conf

    • Settings:

      # Set java.net.useSystemProxies to true to use the system HTTP/HTTPS proxy settings
wrapper.java.additional.700=-Djava.net.useSystemProxies=true

# HTTP settings
wrapper.java.additional.701=-Dhttp.proxyHost=<proxyHostname>
wrapper.java.additional.702=-Dhttp.proxyPort=<port>
wrapper.java.additional.703=-Dhttp.nonProxyHosts=<localhost>
wrapper.java.additional.704=-Dhttp.proxyUser=<user1>
wrapper.java.additional.705=-Dhttp.proxyPassword=<password1>

# HTTPS settings
wrapper.java.additional.710=-Dhttps.proxyHost=<proxyHost-name>
wrapper.java.additional.711=-Dhttps.proxyPort=<port>
wrapper.java.additional.714=-Dhttps.proxyUser=<user1>
wrapper.java.additional.715=-Dhttps.proxyPassword=<password1>
      ▼

      • where

        <proxyHostname>

        The IP address of the proxy server,

        <port>

        The server port for the proxy server, and

        <localhost>

        One or more pipe (|) separated host names for the servers in the configuration. In addition, the wildcard character * can be used for pattern matching. For example, -Dhttp.nonProxyHosts="\*\.foo.com|localhost" indicates every host in the foo.com domain and host, localhost, must be accessed directly even if a proxy server is specified.

        <user1>

        User name for proxyHostname.

        <password1>

        Password for proxyHostname.
        The HTTPS protocol handler uses the same http.nonProxyHosts property as the HTTP protocol.

  4. Restart all the servers where you have applied a proxy setting. Proxy settings do not take effect until the servers are restarted. See Starting and Stopping Servers and Agents Manually.

  5. After setting the configuration, import the HTTPS proxy certificate into the CloudBees CD/RO server Java trust store:

    (Linux) cd /opt/cloudbees/sda/jre/lib/security
(Windows) cd C:\ProgramData\CloudBees\Software Delivery Automation\jre\lib\security

keytool -importcert -file /tmp/CA_crt.pem -keystore cacerts -alias myArtifactory
    ▼

Alternate agent configuration from CloudBees CD/RO server

Instead of configuring each agent’s wrapper.conf file, set agent environment variables in a property sheet on the CloudBees CD/RO server. This allows the proxy settings to be managed centrally by the CloudBees CD/RO server, while the environment variable is available locally to the agent. Agent restart is not required to apply new changes. Create the variable at the zone or individual resource level. For example, to set HTTPS proxy settings:

  • For all agents in the same zone: /zones/zone-a/ec_environment_variables/https_proxy=http://user:password@your-proxy-ip-address:port/

  • For an agent as an individual resource: /resources/agent-b/ec_environment_variables/https_proxy=http://user:password@your-proxy-ip-address:port/

    For further information, see Agent environment variables.

Testing server proxy settings

Use the following task to verify your proxy server settings.

  • From the Plugin Manager web page, verify the configuration:

    • Web server: Verify the catalog can be viewed and no errors are reported when accessing the catalog URL.

    • CloudBees CD/RO server: Verify you can install a plugin from the catalog.

Configure universal access to the plugins directory
System health monitoring