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

CloudBees Flow Server Restores

9 minute read

This section describes common restore related procedures for recovering CloudBees Flow data.

Preparing for a Restore

Before you attempt to restore a CloudBees Flow server:

  • You must have a backup of your source CloudBees Flow server.

  • If you are restoring your data to the exact same database or the same database type (for example, from one MySQL database to another MySQL database on a different system), a database backup is sufficient.

  • If you are switching to a different database type, you will need an XML export.

Any activity on the source server after the backup was created will not exist on the destination server.

  • The destination system must have a CloudBees Flow server already installed and running, and this server must be running the same version or newer version than the source server.

Restoring Your CloudBees Flow Server

The following section contains various procedures for restoring CloudBees Flow data.

All ectool commands used in the following scenarios are fully documented in the CloudBees Flow online help system. See the “Using ectool and the CloudBees Flow API” help topic.

Restore the Same CloudBees Flow Server and Database

Use the following procedure to restore your CloudBees Flow server because of a catastrophic failure or unsuccessful upgrade.

  1. Obtain a backup of the source system.

  2. Stop the destination CloudBees Flow server. For more information, see Starting and Stopping Servers and Agents Manually for platform-specific commands.

  3. If you are using a database dump (where the source and destination systems must both be using the same type of database), load the backup into the destination database.

    This will be done with a command specific to the database you are using.

  4. Start the destination CloudBees Flow server.

  5. If you are using an XML export file, use the ectool import command to import the data into the destination CloudBees Flow server.

  6. Use the ectool shutdownServer --restart 1 command to restart the destination server.

Keep the Same CloudBees Flow Server but Switch the Database

Use the following procedure to restore your CloudBees Flow server if you are doing one of these tasks:

  • Switching from the built-in database installation to an external database.

  • Upgrading to a higher performance system for the database.

    1. Obtain a backup of the source system.

    2. Stop the destination CloudBees Flow server. For more information, see Starting and Stopping Servers and Agents Manually for platform-specific commands.

    3. Stop and disable the original database.

    4. If you are using a database backup (where the source and destination systems must both be using the same type of database), load the database dump into the destination database.

      This will be done with a command specific to the database you are using.

    5. Start the destination CloudBees Flow server.

    6. Set the server database configuration to point to the new database. Point to the new database one of these ways:

      See the “Database Configuration” help topic in the CloudBees Flow web interface.

      Use the ectool setDatabaseConfiguration command.

    7. If you are using an XML export file, use the ectool import command to import the data into the destination CloudBees Flow server.

    8. Use the ectool shutdownServer --restart 1 command to restart the destination server.

Switch the CloudBees Flow Server but Keep the Same Database

Before switching the server, be aware of the following:

  • All files and directories copied to the Destination CloudBees Flow Server should be owned by the user configured to run the CloudBees Flow server daemon.

  • Make sure that the host name of local agent is set to 127.0.0.1 using Cloud > Resources > Local > Resource Details.

  • When you install CloudBees Flow without a built-in database, you can configure the database only by using ectool.

Use the following procedure to restore CloudBees Flow if you are upgrading to a higher performance CloudBees Flow server system.

  1. Make sure you have a backup of the source system.

  2. Check the IP Address System property by selecting Administration > Server > Settings on the old (source) CloudBees Flow system.

    This field is empty by default to enable dynamic connections between the CloudBees Flow server and agents.

    If the field is not empty, you must enter the IP address for the Destination CloudBees Flow Server.

  3. Install a fresh Flow service on the destination CloudBees Flow server.

  4. Stop the destination CloudBees Flow server.

    For more information, see Starting and Stopping Servers and Agents Manually for platform-specific commands.

  5. Stop and disable the source CloudBees Flow server.

  6. Copy the passkey and keystore files from the source CloudBees Flow backup to the destination system. These files are in /opt/electriccloud/electriccommander/conf/ in Linux and in C:\ProgramData\Electric Cloud\ElectricCommander\conf\ in Windows.

  7. Copy the backed-up plugins to the destination system.

    You may encounter one of these scenarios: ** If the /server/settings/pluginsDirectory property does not exist, the server uses the default location (the `plugins ` subdirectory in the data directory).

    + Copy the backed-up plugins to that directory on the destination system.

    • The plugins are stored in a local directory valid on both systems.

      Copy the backed-up plugins to the same directory on the destination system.

    • The plugins are stored in a shared directory valid on both systems.

      You do not need to do anything.

    • The plugins are stored in a directory not accessible on the destination system.

      This can happen * If the source and destination systems have different operating systems (such as Windows to Linux). * If the plugins directory on the source system is on a drive that does not exist on the destination system.

      + Copy the backed-up plugins to a new directory accessible to the destination system. When the server starts, set the /server/settings/pluginsDirectory property to the new directory and restart the CloudBees Flow server.

  8. If you use a MySQL database, do these steps on destination system:

    1. Install the MySQL JDBC driver. For details, see Installing the MySQL JDBC Driver .

    2. Configure access to the CloudBees Flow database user from the IP address or FQDN on the destination system.

  9. Start the destination CloudBees Flow server.

  10. Because the CloudBees Flow host changed, connect the CloudBees Flow database to the new host:

    On the command-line: .. Use ectool setDatabaseConfiguration to specify a database configuration and set the ` --ignoreServerMismatch` option. .. Use the following command to restart the destination server: ectool shutdownServer --restart 1.

    + In the web interface, you should automatically be redirected to the Database Configuration page.

    1. Enter the appropriate database configuration.

    2. Select the Ignore server hostname mismatch check box.

    3. Select Same instance on a new host.

    4. Click Save and Restart.

  11. If you copied the plugins directory to a directory that does not match the plugins directory on the source system:

    1. Set the /server/settings/pluginsDirectory property to this new directory.

      You can use the ectool setProperty command to set this value.

    2. Restart the CloudBees Flow server.

Switch Both the CloudBees Flow Server and Database

Use the following procedure to restore CloudBees Flow if you are upgrading to higher performance systems for both the CloudBees Flow server and the database.

  1. Make sure you have a backup of the source system.

  2. Check the IP Address System property by selecting Administration > Server > Settings on the old CloudBees Flow system.

    This field is empty by default to enable dynamic connections between the CloudBees Flow server and agents.

    If the field is not empty, you must enter the IP address for the new CloudBees Flow server.

  3. Stop the destination CloudBees Flow server.

    For more information, see Starting and Stopping Servers and Agents Manually for platform-specific commands.

  4. Stop and disable the source CloudBees Flow server.

  5. Stop and disable the original database.

  6. Copy the passkey file from the backup to the destination system. The full path name of this file is include:partial$passkey-dir.adoc[] .

  7. Copy the backed-up plugins to the destination system.

    You may encounter one of these scenarios: ** If the /server/settings/pluginsDirectory property does not exist, the server uses the default location (the `plugins ` subdirectory in the data directory).

    + Copy the backed-up plugins to that directory on the destination system.

    • The plugins are stored in a local directory valid on both systems.

      Copy the backed-up plugins to the same directory on the destination system.

    • The plugins are stored in a shared directory valid on both systems.

      You do not need to do anything.

    • The plugins are stored in a directory not accessible on the destination system.

      This can happen: * If the source and destination systems have different operating systems (such as Windows to Linux). * If the plugins directory on the source system is on a drive that does not exist on the destination system.

      + Copy the backed-up plugins to a new directory accessible to the destination system. When the server starts, set the /server/settings/pluginsDirectory property to the new directory and restart the CloudBees Flow server.

  8. If you are using a database backup (where the source and destination systems must both be using the same type of database), load the database dump into the destination database.

    This operation is completed with a command specific to the database you are using.

  9. Start the destination CloudBees Flow server.

  10. Because we have replaced the passkey, the database password is no longer valid. You need to reset the database password (default: commander ) and ignore the passkey mismatch either from the command-line or the web interface.

    • On the command-line, use ectool setDatabaseConfiguration to specify the password and set the --ignoreServerMismatch and --ignorePasskeyMismatch options.

    • In the web interface, you should automatically be redirected to the Database Configuration page. Enter the database password and select the ignore invalid passkey check box.

  11. If you are using an XML export file, use the ectool import command to import the data into the destination CloudBees Flow server.

  12. Use the ectool shutdownServer --restart 1 to restart the destination server.

  13. If you copied the plugins directory to a directory that does not match the plugins directory on the source system, set the /server/settings/pluginsDirectory property to this new directory and restart the CloudBees Flow server.

    You can use the ectool setProperty command to set this value.

Create a Clone of the CloudBees Flow Server and the Database

Use the following procedure to restore your CloudBees Flow server if you are setting up a production-like environment for testing.

  1. Make sure you have a backup of the source system.

  2. Check the IP Address System property by selecting Administration > Server > Settings on the old CloudBees Flow system.

    This field is empty by default to enable dynamic connections between the CloudBees Flow server and agents.

    If the field is not empty, you must enter the IP address for the new CloudBees Flow server.

  3. Stop the destination CloudBees Flow server.

    For more information, see Starting and Stopping Servers and Agents Manually for platform-specific commands.

  4. Copy the passkey file from the backup to the destination system. The full path name of this file is include:partial$passkey-dir.adoc[] .

  5. Copy the backed-up plugins to the destination system.

    You may encounter one of these scenarios: ** If the /server/settings/pluginsDirectory property does not exist, the server uses the default location (the `plugins ` subdirectory in the data directory).

    + Copy the backed-up plugins to that directory on the destination system.

    • The plugins are stored in a local directory valid on both systems.

      Copy the backed-up plugins to the same directory on the destination system.

    • The plugins are stored in a shared directory valid on both systems.

      You do not need to do anything.

    • The plugins are stored in a directory not accessible on the destination system.

      This can happen: * If the source and destination systems have different operating systems (such as Windows to Linux). * If the plugins directory on the source system is on a drive that does not exist on the destination system.

      + Copy the backed-up plugins to a new directory accessible to the destination system. When the server starts, set the /server/settings/pluginsDirectory property to the new directory and restart the CloudBees Flow server.

  6. If you are using a database backup (the source and destination systems must be using the same type of database), create the destination database, give the appropriate database user permissions to the schema (as mentioned in External Database Configuration ), and load the database dump into the destination database.

    This operation is completed with a command specific to the database you are using.

  7. If you are using a database backup, disable schedules, resources, or both on both servers.

    • Two servers should never talk to the same agent. The two servers share the same identity because they share exact copies of the database.

    • Disabling schedules prevents jobs from launching unexpectedly.

    • Disabling resources prevents scheduled or manually launched jobs from running on production agents. This operation is completed with a command specific to the database you are using.

  8. Start the destination CloudBees Flow server.

  9. Because we have replaced the passkey, the database password is no longer valid. You need to reset the database password (default: commander ) and ignore the passkey mismatch either from the command-line or the web interface.

    • On the command-line, use ectool setDatabaseConfiguration to specify the password and set the --ignoreServerMismatch and --ignorePasskeyMismatch options.

    • In the web interface, you should automatically be redirected to the Database Configuration page. Enter the database password and select the ignore invalid passkey check box.

  10. If you are using an XML export file, disable schedules, resources, or both on both servers.

    • Two servers should never “talk” to the same agent. The two servers share the same identity because they share exact copies of the database.

    • Disabling schedules prevents jobs from being launched unexpectedly.

    • Disabling resources prevents scheduled or manually launched from running on production agents.

      Disable the schedules and resources one of these ways:

    • Modify the import file by replacing <resourceDisabled>0</resourceDisabled> with <resourceDisabled>1</resourceDisabled>.

    • Use the ectool import command with the --disableSchedules flag turned on to disable schedules.

  11. Use the ectool shutdownServer --restart 1 command to restart the destination server.

  12. If you copied the plugins directory to a directory that does not match the plugins directory from the source system,set the /server/settings/pluginsDirectory property to the new directory and restart the CloudBees Flow server.

    You can use the ectool setProperty command to set this value.

CloudBees Flow server backups
Switching to an alternate database