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
IntroductionSpecial-case installationsInstaller optionsDefault installation directoriesVerify installation binariesAgent configuration recommendations
IntroductionInstall a default configurationInstall a custom configurationRun an express agent UI installationRun an express UI installation (agent-only installer)Run an advanced UI 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 users and groupsActive usersCreate or edit a local userUser detailsGroupsCreate or edit a local groupGroup detailsPersonasConfigure 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 Kibana 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/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 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 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 steps and tasksExample: 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
IntroductionCloudBees CD/RO artifactsCreate or edit artifactsArtifact versionsEdit an existing artifact versionRepositories
Create object tagsCreate object schedules
IntroductionConfigure webhook triggersConfigure polling triggers
IntroductionConfigure email notificationsSelect and edit email messages for application or microservice processes
Introduction
IntroductionInstall pluginsCreate plugin configurationsManage pluginsCreate pluginsManage the plugin catalog

Configure IP protocols for Helm chart components

5 minute read

Starting with v2024.03.0, you can configure CloudBees CD/RO components to specifically use IPv4 or IPv6 protocols. To set the preferred IP protocol, the protocol must be set in the component wrapper configuration file, which can be passed from the component Helm chart.

The capability to configure CloudBees CD/RO components to use specific IP protocols is only possible in v2024.03.0 and later. You must install or upgrade to v2024.03.0 or later to enable this feature.

If you attempt to perform the following configurations on earlier versions, your installation/upgrade may fail or your platform components will be unable to communicate with CloudBees CD/RO.

For the Java-based CloudBees CD/RO components:

  • flow-server

  • flow-agent

  • flow-repository

There are two directives that can be used with specific options:

  • java.net.preferIPv4Stack=true|false

  • java.net.preferIPv6Addresses=true|false

The behavior of these directives is described in the following table:

Table 1. IP protocol configuration behavior

java.net.preferIPv4Stack

java.net.preferIPv6Addresses

default address

true

false

IPv4 only 1

false (DEFAULT)

false (DEFAULT)

IPv4 preferred 2

false

true

IPv6 preferred 3!
Table annotations

  • 1 IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • 2 This is the default configuration. IPv4 is preferred, but if IPv4 is not available, IPv6 is used.

  • 3 IPv6 is preferred, but if IPv6 is not available, IPv4 is used.

    If you are using CloudBees CD/RO in an IPv6-based clustered multi-node environment, you must set server.ecconfigure to use preferIPv6Addresses=true. For more information, refer to Configure IP protocol for CloudBees CD/RO server.
By default, all CloudBees CD/RO components are set to accept communications from both IPv4 and IPV6 hosts. If you configure any CloudBees CD/RO component to use only IPv4 hosts, the component will not accept communications from IPv6 hosts, even in situations where no IPv4 host is present.

The web server (web-server) is PHP-based, and uses:

  • System settings (DEFAULT): --webPhpCurlIPResolve=WHATEVER 1

  • IPv4 only: --webPhpCurlIPResolve=IPv4 2

  • IPv6 only: --webPhpCurlIPResolve=IPv6 3

List annotations

  • 1 Default. Uses whatever IPs are allowed by your system.

  • 2 IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • 3 IPv6 hosts only, and the component will not communicate with IPv4 hosts.

By default, all CloudBees CD/RO components are set to accept communications from both IPv4 and IPV6 hosts. If you configure any CloudBees CD/RO component to use only IPv4 hosts, the component will not accept communications from IPv6 hosts, even in situations where no IPv4 host is present.

The following sections describe the specific procedures for setting these configuration for each component.

Configure IP protocol for CloudBees CD/RO server

By default, the CloudBees CD/RO server (flow-server) is configured to communicate with both IPv4 and IPv6 hosts. Where IPv4 hosts are preferred, but if an IPv4 host is not available, an IPv6 host can be used.

If you are using CloudBees CD/RO in an IPv6-based clustered multi-node environment, you must set server.ecconfigure to use preferIPv6Addresses=true.

Starting in v2024.03.0, you can configure CloudBees CD/RO components to use specific IP protocols or to prefer different protocols. To do so, set the desired option for server.ecconfigure in your cloudbees-flow values file:

  • To use only IPv4 hosts, configure server.ecconfigure to:

    ecconfigure: "--serverInitMemoryMB=4096 --serverMaxMemoryMB=4096 --wrapperJavaAdditional=10001=-Djava.net.preferIPv4Stack=true"
    ▼
    Using the above configuration results in communication with IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • To use IPv6 as the preferred host, configure server.ecconfigure to:

    ecconfigure: "--serverInitMemoryMB=4096 --serverMaxMemoryMB=4096 --wrapperJavaAdditional=10002=-Djava.net.preferIPv6Addresses=true"
    ▼
    Using the above configuration results IPv6 being the preferred host. However, if an IPv6 host is not available, an IPv4 is still accepted.

Configure IP protocol for CloudBees CD/RO repository

By default, the CloudBees CD/RO repository (flow-repository) is configured to communicate with both IPv4 and IPv6 hosts. Where IPv4 hosts are preferred, but if an IPv4 host is not available, an IPv6 host can be used.

Starting in v2024.03.0, you can configure CloudBees CD/RO components to use specific IP protocols or to prefer different protocols. To do so, set the desired option for repository.ecconfigure in your cloudbees-flow values file:

  • To use only IPv4 hosts, configure repository.ecconfigure to:

    ecconfigure: "--repositoryInitMemoryMB=512 --repositoryMaxMemoryMB=1024 --repositoryWrapperJavaAdditional=10001=-Djava.net.preferIPv4Stack=true"
    ▼
    Using the above configuration results in communication with IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • To use IPv6 as the preferred host, configure repository.ecconfigure to:

    ecconfigure: "--repositoryInitMemoryMB=512 --repositoryMaxMemoryMB=1024 --repositoryWrapperJavaAdditional=10002=-Djava.net.preferIPv6Addresses=true"
    ▼
    Using the above configuration results IPv6 being the preferred host. However, if an IPv6 host is not available, an IPv4 is still accepted.

Configure IP protocol for CloudBees CD/RO web server

By default, the CloudBees CD/RO web (web-server) is configured to communicate with both IPv4 and IPv6 hosts. Where IPv4 hosts are preferred, but if an IPv4 host is not available, an IPv6 host can be used.

Starting in v2024.03.0, you can configure CloudBees CD/RO components to use specific IP protocols or to prefer different protocols. To do so, set the desired option for web.ecconfigure in your cloudbees-flow values file:

  • To use only IPv4 hosts, configure web.ecconfigure to:

    ecconfigure: "--webPhpCurlIPResolve=IPv4"
    ▼
    Using the above configuration results in communication with IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • To use IPv6 as the preferred host, configure web.ecconfigure to:

    ecconfigure: "--webPhpCurlIPResolve=IPv6"
    ▼
    Using the above configuration results in communication with IPv6 hosts only, and the component will not communicate with IPv4 hosts.

Configure IP protocol for CloudBees Analytics server

By default, the CloudBees Analytics server (cloudbees-devopsinsight) is configured to communicate with both IPv4 and IPv6 hosts. Where IPv4 hosts are preferred, but if an IPv4 host is not available, an IPv6 host can be used.

Starting in v2024.03.0, you can configure CloudBees CD/RO components to use specific IP protocols or to prefer different protocols. To do so, set the desired option for dois.extraEnvs in your cloudbees-flow values file:

  • To use only IPv4 hosts, configure dois.extraEnvs to:

    extraEnvs:
  - name: CBF_DOIS_PREFER_IPV4_ADDRESSES
    value: "true"
    ▼
    Using the above configuration results in communication with IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • To use IPv6 as the preferred host, configure dois.extraEnvs to:

    extraEnvs:
  - name: CBF_DOIS_PREFER_IPV6_ADDRESSES
    value: "true"
    ▼
    Using the above configuration results IPv6 being the preferred host. However, if an IPv6 host is not available, an IPv4 is still accepted.

Configure IP protocol for CloudBees CD/RO agents

By default, CloudBees CD/RO bound agents (flow-bound-agent) are configured to communicate with both IPv4 and IPv6 hosts. Where IPv4 hosts are preferred, but if an IPv4 host is not available, an IPv6 host can be used.

Starting in v2024.03.0, you can configure CloudBees CD/RO components to use specific IP protocols or to prefer different protocols. To do so, set the desired option for boundAgent.ecconfigure in your cloudbees-flow values file:

  • To use only IPv4 hosts, configure boundAgent.ecconfigure to:

    ecconfigure: "--agentInitMemoryMB=256 --agentMaxMemoryMB=256 --agentWrapperJavaAdditional=10001=-Djava.net.preferIPv4Stack=true"
    ▼
    Using the above configuration results in communication with IPv4 hosts only, and the component will not communicate with IPv6 hosts.

  • To use IPv6 as the preferred host, configure boundAgent.ecconfigure to:

    ecconfigure: "--agentInitMemoryMB=16 --agentMaxMemoryMB=64" --agentWrapperJavaAdditional=10002=-Djava.net.preferIPv6Addresses=true"
    ▼
    Using the above configuration results IPv6 being the preferred host. However, if an IPv6 host is not available, an IPv4 is still accepted.

Apply IP protocol changes to Kubernetes deployments

For IP protocol changes in your values file Helm charts to take effect, they must be applied to your installation or updated in your deployment. For more information, refer to:

Kubernetes configuration options
Configure GitOps with Helm charts