Installation on Kubernetes (PREVIEW)
Introduction
Special-case installations
Installer options
Server topology best practices
Pre-installation checklist
Default installation directories
IntroductionExpress serverAdvanced serverExpress agentExpress Agent-onlyAdvanced Agent-onlyDevOps Insight Server
IntroductionExpress serverAdvanced serverExpress AgentExpress Agent-only (standalone)Advanced Agent-only (standalone)DevOps Insight server installation
IntroductionSilent install overviewSilent install argumentsLinux installation examplesWindows installation examplesLinux repository server installation exampleWindows repository server installation exampleWindows or Linux DevOps Insight server installation example
IntroductionUNIX agent interactive command-lineUNIX agent unattended
IntroductionPrerequisitesPermissionsInstalling via the web interfaceInstalling via the API
Moving the artifact repository in Linux
Moving the artifact repository in Windows
Connecting Flow to a Microsoft SQL server
Installing the MySQL JDBC driver
IntroductionUninstalling CloudBees Flow on Linux, Unix, or macOSUninstalling CloudBees Flow on WindowsUninstalling the CloudBees Flow DevOps Insight Server on LinuxUninstalling the CloudBees Flow DevOps Insight Server on Windows
Signing in to Flow
IntroductionThe Default Zone and Gateways to Remote ZonesApplying an Enterprise License KeyExternal Database ConfigurationConfiguring CloudBees Flow to Use an Alternate DatabaseConfiguring Server and Agent Services Autostart for Non-Root/Non-sudo Linux InstallationsUniversal Access to the Plugins DirectoryConfiguring Single Sign-OnEnvironment Proxy Server ConfigurationIncreasing File Descriptors on LinuxAdjusting Swappiness on LinuxSetting Variables on Windows Agent MachinesConfiguring Kibana to Work With DevOps Insight
IntroductionArchitecture of a CloudBees Flow ClusterResource, agent, and procedure considerationsSoftware for clusteringDependencies for clusteringConfiguring clusteringSeparating agents from flow serversPreparing your cluster resourcesInstalling and configuring a load balancerInstalling zooKeeperConfiguring a multi-zookeeper clusterInstalling Flow softwareConfiguring repository serversConfiguring machines to operate in clustered modeRunning a cluster in single-server modeAdding the configuration to zookeeperUploading configuration files to zookeeperGetting Information on the Flow server cluster from zookeeperAdding a node to an existing clusterConfiguring web server propertiesConfiguring repository server propertiesConfiguring Flow agentsConfiguring the cluster workspaceConfiguring Flow repositoriesAdding trusted agents to clustersVerifying Flow servicesAccessing Flow with clusteringHealth check for the Flow clusterAdditional Ways to improve a clusterInstalling the DevOps Insight server in cluster modeDisaster recovery
IntroductionCloudBees Flow server backupsRestoring a Flow ServerSwitching to an alternate databaseSwitching to the built-in databaseMaintaining DevOps Insight server dataApache web server or agent certificatesUsing chkconfigStarting and stopping servers and agents manuallyCollecting Flow logsWeb interface online help system
IntroductionCloudBees Flow ArchitectureRoadmap to CloudBees FlowPlugins and Cloudbees Field-Contributed SolutionsGuided Tutorials
IntroductionSigning in to CloudBees FlowHome PagePersonasAccess ControlMy Work DashboardObject List LayoutObject SchedulesPaginationSearching and FilteringHierarchy MenuProperty BrowserProjects in CloudBees FlowObject Tags
IntroductionApplications and ProcessesEnvironmentsCreating or Editing a Project in the Deploy Web UIParametersMaster ComponentsMaster Component ExamplesMaster Components List UIArtifact StagingRollbackManaging Application or Microservice DependenciesManual Steps and TasksProcess BranchingProperty Reference Use CaseSnapshotsInventory TrackingEnvironment InventoryMicroservice Deployment Using ContainersDeployment PackagesDeployment StrategiesDeployment ExamplesAutomated Environment DiscoveryEnvironment ReservationsFull-Stack Dependency ViewConfiguration Drift
IntroductionGuidelines for Modeling and Deploying Applications in CloudBees FlowExamples: Modeling and Deploying ApplicationsExample: Manual Step with Runtime ParametersAttaching Credentials to Application and Component ProcessesPlugin Process StepsAdding Process Steps
IntroductionModeling Dynamic EnvironmentsDeploying Applications with Provisioned Cloud ResourcesRetiring Dynamic EnvironmentsDynamic Environment Example with Amazon and ChefDeveloper Task: Creating Custom Plugins
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesEvent-based triggers Pipeline UI
IntroductionDefining gate approvalsPipeline objects and conditionsPipeline stage summaryCredentials in pipelinesRunning pipelinesViewing pipeline runsTroubleshooting pipelines
IntroductionExample: Creating a manual task in a pipelineExample: plugin pipeline tasksExample: integrating test automation in release pipelinesExample: leveraging test data management and service virtualization in release pipelines
IntroductionRelease ConceptsRelease Planning, Scheduling, and TrackingRelease and Environment Reservations CalendarVisibility and Status of Release PipelinesRelease DefinitionRelease DashboardPlanned Versus Actual ViewPath to Production ViewRelease SummaryRunning and Ending Releases
Data Retention
IntroductionPerformance consequences of change trackingEstimating database growthBest practices for change trackingConfiguring change trackingSearching the change historyViewing the change historyModifying what you see in the change historyReverting changes to a tracked object and its tracked contentsExporting a previous state of a tracked object and its tracked contents
Self-Service Catalogs
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
Plugin list
Introduction
Build-Test Automation
IntroductionScenario 1 - Creating a simple procedureScenario 2 - Creating a procedure that uses an SCMScenario 3 - Notification, scheduling, and reportingScenario 4 - Multi-agent build and test
IntroductionAutomation Platform Home PageCustomizing the Automation Platform UIConfiguring CloudBees FlowUsing Cloudbees Flow in Your EnvironmentCloudBees Flow Installed Tools
IntroductionAccess ControlDefining entriesPrivileges - create new or edit existing privilegesArtifactsArtifact detailsCreate new or edit existing artifactArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositoriesEmail configurationsCreate new or edit existing email configurationsEmail NotifiersProcedure DetailsCreate new or edit existing procedureCreate new or edit existing stepPublish Artifact Version stepRetrieve Artifact Version stepSend Email stepNew Extract Preflight Sources stepParameter - create new or edit existing parameterProjectsCreate new or edit existing projectProject DetailsRun ProcedureCreate new or edit existing scheduleCreate new or edit existing credentialProperty - create new or edit existing propertyNested Property SheetReportsCreate a new reportSearching and FilteringSearch ResultsSource Control ConfigurationsCreate new or edit existing configurationsUsersUsers and GroupsCreate new or edit existing local userUser DetailsEdit User SettingsGroupsCreate new or edit existing groupGroup DetailsDirectory ProvidersCreate new or edit existing directory providersSingle Sign-OnTest Directory ProviderWorkflowsWorkflow Definition - create new or edit exiting workflow definitionWorkflow Definition DetailsRun WorkflowWorkflow DetailsWorkflow LogTransition WorkflowWorkspacesWorkspace - create new or edit existing workspaceWorkspace fileDatabase ConfigurationDefect Tracking ConfigurationsDefect Tracking - create new or edit existing configurationDefect Tracking ReportsEvent LogHome PageJob ConfigurationShortcutsJobs Quick ViewNew ReportJobsJob Step DetailsLicensesView LicenseImport LicensePlugin ManagerResources/PoolsResource PoolsResource Pool - create new or edit existing poolResource Pool DetailsZonesGatewaysServerSettings - edit existing property settings
IntroductionAccess ControlArtifact ManagementAuthenticating Users for LDAP and Active DirectoryAuto-DiscoveryDefect TrackingElectricSentryJob Step Execution EnvironmentPreflight BuildsPropertiesPostprocessorsReportsWorkflow OverviewWorkspaces and Disk Space Management
IntroductionAdding a Link to a JobCalling a SubprocedureChecking the Outcome of Preceding StepsConditional ExecutionCustom Parameter LayoutsEmail NotificationsExecuting Tasks on All Resources in a PoolFactory ProceduresPostp ExtensionPublishing and Retrieving an ArtifactReserving a Resource for the Job Step DurationRunning Steps in ParallelStep Timeouts and Steps That Always RunStoring and Retrieving Properties in a JobWorking with Properties Stored in a Procedure
Using Special Characters in Object Names

Roadmap for upgrading CloudBees Flow

1 minute read
Upgrading CloudBees Flow versions between 5.x and 8.2 that are using the built-in (default) database is not supported. This means that you must switch to an alternate CloudBees Flow-supported database before your upgrade. For instructions, see Switching to an alternate database.
Clustered environment Link to the upgrade process steps

Yes

Upgrading a clustered environment

No

Upgrading a non-clustered environment

Server components in CloudBees Flow

For a detailed description, see the KBEC-00041 - CloudBees Flow TCP port usage-diagram and descriptions KB article.

Upgrading a non-clustered environment