Introduction
Architecture
Flow glossary
Introduction
Flow server and agent compatibility
Flow server and DevOps Insight compatibility
Platform notes
Port usage
Hardware requirements
Browser requirements
Java requirements
Database requirements
Database sizing
Disk usage
Memory settings
Checksum utility
Software licenses
Installation on Kubernetes (PREVIEW)
Introduction
Special-case installations
Installer options
Server topology best practices
Pre-installation checklist
Default installation directories
Graphical UI installation
IntroductionExpress serverAdvanced serverExpress agentExpress Agent-onlyAdvanced Agent-onlyDevOps Insight Server
Interactive Command-Line Installation
IntroductionExpress serverAdvanced serverExpress AgentExpress Agent-only (standalone)Advanced Agent-only (standalone)DevOps Insight server installation
Silent unattended 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
Non-server platform UNIX agent installation
IntroductionUNIX agent interactive command-lineUNIX agent unattended
Installing remote agents
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
Uninstalling CloudBees Flow
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
General configuration
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
Horizontal scalability configuration
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
Maintenance
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
Upgrade roadmap for traditional platforms
Upgrading a non-clustered environment
Upgrading a clustered environment
Choosing the correct upgrade method
IntroductionUser interface upgrade methodInteractive command-line upgrade methodSilent (unattended) upgrade methodCopying repository contents
Upgrading remote agents
Upgrading the DevOps Insight server
Configuration settings preserved after an upgrade
Introduction to CloudBees Flow
IntroductionCloudBees Flow ArchitectureRoadmap to CloudBees FlowPlugins and Cloudbees Field-Contributed SolutionsGuided Tutorials
Deploy UI Elements
IntroductionSigning in to CloudBees FlowHome PagePersonasAccess ControlMy Work DashboardObject List LayoutObject SchedulesPaginationSearching and FilteringHierarchy MenuProperty BrowserProjects in CloudBees FlowObject Tags
Deployment Automation
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
Deployment Examples
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
Deploying Applications in Dynamic Environments
IntroductionModeling Dynamic EnvironmentsDeploying Applications with Provisioned Cloud ResourcesRetiring Dynamic EnvironmentsDynamic Environment Example with Amazon and ChefDeveloper Task: Creating Custom Plugins
Pipeline concepts
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesEvent-based triggers Pipeline UI
Authoring and running pipelines
IntroductionDefining gate approvalsPipeline objects and conditionsPipeline stage summaryCredentials in pipelinesRunning pipelinesViewing pipeline runsTroubleshooting pipelines
Pipeline examples
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
Release Management
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
Change tracking
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
Notifications
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
DevOps Insight Overview
Understanding the DevOps Insight Data Model
Creating a Report
Creating a Dashboard
IntroductionCreating a New Dashboard Using the UICopying an Existing DashboardAdding Widgets to an Existing Dashboard
Elasticsearch Basics
Extending the Data Model
Dashboard Reference
IntroductionViewing a DashboardReleases DashboardApplication Deployments DashboardMicroservice Deployments DashboardRelease Command Center DashboardContinuous Integration DashboardCode Commit Trends Dashboard
Configuring the DevOps Insight Server
Introduction
Platform notes
IntroductionSoftware Licenses
Installing DevOps Foresight
IntroductionGraphical User Interface InstallationInteractive Command-Line InstallationSilent Unattended Installation Example
Configuration
Upgrading
Uninstalling
IntroductionUninstalling on LinuxUninstalling on Windows
Introduction
Credentials and user impersonation
Credentials application and component processes
Use Case: using credentialsin deployment automation
credentials in pipelines
credentials in releases
Cross-site request forgery protection
Plugin list
Introduction
CloudBees Flow server is unresponsive and displays an outofmemory error
Windows PHP does not handle time zones correctly
CloudBees Flow self-signed server certificate fails security scan
CloudBees Flow CA or intermediate CA certificate expires
Linux upgrade breaks symbolic links
Built-In database schema on disk is older than required by CloudBees Flow server for upgrade
Introduction
Build-Test Automation
Getting Started
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
Automation Platform Setup
IntroductionAutomation Platform Home PageCustomizing the Automation Platform UIConfiguring CloudBees FlowUsing Cloudbees Flow in Your EnvironmentCloudBees Flow Installed Tools
Automation Platform Tasks
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
Automation Platform Objects and Functionality
IntroductionAccess ControlArtifact ManagementAuthenticating Users for LDAP and Active DirectoryAuto-DiscoveryDefect TrackingElectricSentryJob Step Execution EnvironmentPreflight BuildsPropertiesPostprocessorsReportsWorkflow OverviewWorkspaces and Disk Space Management
Tutorials
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
Support policies
Supported platforms
CloudBees subscription and services agreement
Feature definitions

Default Installation Directories

1 minute read

CloudBees Flow uses the following default installation directories:

PlatformData TypeDefault Path

Windows

Program files

C:\Program Files\Electric Cloud\ElectricCommander

UNIX and macOS

All program files and data

/opt/Electric Cloud/ElectricCommander

You can change the installation directories when you install the CloudBees Flow software.
Pre-installation checklist