Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsScale resources manually using a procedureScale resources using Custom AutoscalingCentralize log storage for serversConfigure 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
Upgrade CloudBees CD/RO on KubernetesConfiguration settings preserved after a Kubernetes upgrade
Upgrade Kubernetes CloudBees Analytics environments to OpenSearchMigrate CloudBees Analytics data from Elasticsearch to OpenSearch
IntroductionUpgrade a non-clustered environmentUpgrade a clustered environmentUI upgrade methodInteractive command-line upgrade methodRun a silent upgradeCopy repository contentsUpgrade remote agentsUpgrade the CloudBees Analytics serverConfiguration settings preserved after a traditional upgrade
Upgrade traditional CloudBees Analytics environments to OpenSearchMigrate CloudBees Analytics data from Elasticsearch to OpenSearch
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 artifactsManage 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 serverRestore a CloudBees CD/RO serverChange the database passwordSwitch to an alternate databaseSwitch from an alternate database to the built-in databaseCollect CloudBees CD/RO logsAudit CloudBees CD/RO server logsView event logsGenerate a new Apache web server or agent certificateStart and stop servers and agents manually
Back up CloudBees CD/RO on KubernetesRestore CloudBees CD/RO on KubernetesConfigure a disaster recovery site for CloudBees CD/ROConfigure a disaster recovery site for CloudBees Analytics
IntroductionMaintain CloudBees Analytics server dataMaintain CloudBees Analytics server data on KubernetesRollback CloudBees Analytics via snapshotStart and stop servers and agents manually
IntroductionchkconfigClusterInfoTooleccertecconfigureecdaemonecproxyecremotefilecopyec-specsZKConfigTool

Property error codes

1 minute readAutomation

The following list provides error codes that may appear as a value within an errorCode property.

ABORTED

AGENT_UNKNOWN_COMMAND

ACCESS_DENIED

AGENT_WRONG_FILE_TYPE

AGENT_BAD_WORKINGDIR

BAD_AGENT_RESPONSE

AGENT_FAILED_CONNECT_BROKER

BAD_LOGFILE_PATH

AGENT_FAILED_CREATE_FILE

CANCELED

AGENT_FAILED_CREATE_WORKSPACE

CIRCULAR_PROCEDURE_REFERENCE

AGENT_FAILED_IMPERSONATION

CORRUPT_CREDENTIAL

AGENT_FAILED_MAP_DRIVE

DUPLICATE_JOB_NAME

AGENT_FAILED_PROXYTARGET_PING

EMPTY_SUBPROCEDURE

AGENT_INCOMPATIBLE_VERSION

FAILED_JOB_RENAME

AGENT_INTERNAL_ERROR

FORMAL_PARAMETER_ERROR

AGENT_INVALID_CWD

INTERNAL_ERROR

AGENT_INVALID_MESSAGE

INVALID_EMAIL_HEADER

AGENT_INVALID_PING_TOKEN

MY_EVENT_EXPANSION_ERROR

AGENT_INVALID_WORKSPACE

NO_EMAIL_HEADERS_SEPARATOR

AGENT_IO_CONNECTION_REFUSED

NONEXISTENT_EMAIL_CONFIG

AGENT_IO_CONNECTION_RESET

NONEXISTENT_PROCEDURE

AGENT_IO_ERROR

NONEXISTENT_RESOURCE

AGENT_IO_NO_ROUTE_TO_HOST

NONEXISTENT_WORKSPACE

AGENT_IO_PORT_UNREACHABLE

NOTIFIER_EXPANSION_ERROR

AGENT_MALFORMED_XML

POST_PROCESSOR_ERROR

AGENT_NONABSOLUTE_PATH

POST_PROCESSOR_OUTPUT_FAILURE

AGENT_NONEXISTENT_DIR

PROPERTY_REFERENCE_ERROR

AGENT_NONEXISTENT_FILE

RESOURCE_WITHOUT_HOSTNAME

AGENT_PING_FAILED

SERVER_SHUTDOWN

AGENT_STREAM_STOPPED

TIMEOUT

AGENT_TIMEOUT

UNKNOWN_HOST

AGENT_UNKNOWN_CMDID

AGENT_UNKNOWN_COMMAND

AGENT_WRONG_FILE_TYPE

AGENT_UNKNOWN_COMMAND

BAD_AGENT_RESPONSE

AGENT_WRONG_FILE_TYPE

BAD_LOGFILE_PATH

BAD_AGENT_RESPONSE

CANCELED

BAD_LOGFILE_PATH

CIRCULAR_PROCEDURE_REFERENCE

CANCELED

CORRUPT_CREDENTIAL

CIRCULAR_PROCEDURE_REFERENCE

DUPLICATE_JOB_NAME

CORRUPT_CREDENTIAL

EMPTY_SUBPROCEDURE

DUPLICATE_JOB_NAME

FAILED_JOB_RENAME

EMPTY_SUBPROCEDURE

FORMAL_PARAMETER_ERROR

FAILED_JOB_RENAME

INTERNAL_ERROR

FORMAL_PARAMETER_ERROR

INVALID_EMAIL_HEADER

INTERNAL_ERROR

MY_EVENT_EXPANSION_ERROR

INVALID_EMAIL_HEADER

NO_EMAIL_HEADERS_SEPARATOR

MY_EVENT_EXPANSION_ERROR

NONEXISTENT_EMAIL_CONFIG

NO_EMAIL_HEADERS_SEPARATOR

NONEXISTENT_PROCEDURE

NONEXISTENT_EMAIL_CONFIG

NONEXISTENT_RESOURCE

NONEXISTENT_PROCEDURE

NONEXISTENT_WORKSPACE

NONEXISTENT_RESOURCE

NOTIFIER_EXPANSION_ERROR

NONEXISTENT_WORKSPACE

POST_PROCESSOR_ERROR

NOTIFIER_EXPANSION_ERROR

POST_PROCESSOR_OUTPUT_FAILURE

POST_PROCESSOR_ERROR

PROPERTY_REFERENCE_ERROR

POST_PROCESSOR_OUTPUT_FAILURE

RESOURCE_WITHOUT_HOSTNAME

PROPERTY_REFERENCE_ERROR

SERVER_SHUTDOWN

RESOURCE_WITHOUT_HOSTNAME

TIMEOUT

SERVER_SHUTDOWN

UNKNOWN_HOST

TIMEOUT

AGENT_UNKNOWN_COMMAND

UNKNOWN_HOST
Context-relative shortcuts to property paths
Configure properties or property sheets