IntroductionInstallationConfiguring Helm chartsConfiguring internal and external agentsAutoscaling gateway agentsVerifying Helm chartsCreating Docker imagesVerifying Docker imagesUsing Google Cloud SQLFrequently asked questions
IntroductionSpecial-case installationsInstaller optionsServer topology best practicesDefault installation directoriesVerifying installation binaries
IntroductionDefault configurationCustom configurationExpress agentExpress agent-onlyAdvanced agent-onlyCloudBees Analytics server
IntroductionExpress serverAdvanced serverExpress agentExpress agent-only (standalone)Advanced agent-only (standalone)CloudBees Analytics server installation
IntroductionSilent install overviewSilent install argumentsLinux installation examplesWindows installation examplesLinux repository server installation exampleWindows repository server installation exampleWindows or Linux CloudBees Analytics 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 CloudBees CD/RO to a Microsoft SQL server
Installing the MySQL JDBC driver
IntroductionUninstalling CloudBees CD/RO on Linux, Unix, or macOSUninstalling CloudBees CD/RO on WindowsUninstalling the CloudBees Analytics Server on LinuxUninstalling the CloudBees Analytics Server on Windows
Signing in to CloudBees CD/RO
IntroductionConfiguring initial events for Workload Insights
Introduction
Microservice applications
IntroductionArtifact stagingSnapshotsRollbackManaging dependencies
IntroductionApplications and processesManaging ApplicationsCreating processesAdding process stepsProcess branchingConfiguring plugin process stepsManual steps and tasksExample: manual step with runtime parameters
IntroductionCreating environmentsCreating environment tier mapsInventory trackingEnvironment inventoryGlobal environment inventoryEnvironment reservationsEnvironment lockingModeling dynamic environmentsAutomated environment discoveryExample: dynamic environment with Amazon and Chef
IntroductionMaster Component ExamplesMaster components list
IntroductionApplication deploy optionsDeploying and troubleshooting applicationsDeployment packagesDeployment examplesDeploying applications with provisioned cloud resourcesExample: implementing deployment strategies
Property reference use case
Creating a project
Parameters
Full-stack dependency view
Configuration drift
Attaching credentials to processes
Developer task: creating custom plugins
IntroductionRelease and Environment Reservations CalendarVisibility and Status of Release PipelinesRelease DefinitionRelease DashboardPlanned Versus Actual ViewPath to Production ViewRelease SummaryRunning and Ending Releases
IntroductionPipeline stages and gatesPipeline access controlPipeline tasksEntry and exit gatesPipeline conditionsPipeline start and end stages and stage skippingWait dependenciesNative CI integration Pipeline UI
IntroductionDefining gate approvalsPipeline objects and conditionsPipeline stage summaryCredentials in 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 pipelinesExample: Surfacing Jenkins build details in Flow
Signing in to CloudBees CD/RO
Guided Tutorials
Home page
Personas
Viewing and changing access control privileges on objects
My work dashboard
Object list layout
Object schedules
Event-based triggers
IntroductionPaginationSearching and filteringHierarchy menuProperty browserProjects in CloudBees CD/ROObject tags
IntroductionClusterInfoTooleccertecconfigureecdaemonecproxyecremotefilecopyZKConfigtool
IntroductionThe default zone and gateways to remote zonesSetting agent environment variablesLicensesExternal Database ConfigurationConfiguring CloudBees CD/RO to Use an Alternate DatabaseConfiguring autostart for non-root/non-sudo Linux installationsUniversal access to the plugins directoryEnvironment proxy server configurationSystem health monitoringIncreasing file descriptors on LinuxAdjusting swappiness on LinuxSetting variables on Windows agent machinesConfiguring Kibana to work with CloudBees AnalyticsServer propertiesServer settingsSource code synchronizationGitOps configuration with Helm charts
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
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
Producing audit reports
Configuration drift
IntroductionInstalling pluginsCreating configurationsManaging pluginsCreating pluginsManaging the plugin catalog
Self-Service Catalogs
IntroductionArchitecture of a CloudBees CD/RO 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 CloudBees CD/RO 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 CloudBees CD/RO server cluster from ZooKeeperAdding a node to an existing clusterConfiguring web server propertiesConfiguring repository server propertiesConfiguring CloudBees CD/RO agentsConfiguring the cluster workspaceConfiguring CloudBees CD/RO repositoriesAdding trusted agents to clustersVerifying CloudBees CD/RO servicesAccessing CloudBees CD/RO with clusteringHealth check for the CloudBees CD/RO clusterAdditional Ways to improve a clusterInstalling the CloudBees Analytics server in cluster modeUsing self-signed certificates in CloudBees CD/RO on KubernetesDisaster recovery
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 CD/ROUsing CloudBees CD/RO in your environmentCloudBees CD/RO Installed tools
IntroductionArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingElectricSentryJob step execution environmentPreflight buildsPostprocessorsReportsWorkflow overviewWorkspaces and disk space management
IntroductionIntrinsic propertiesReserved wordsProperty shortcutsProperty error codes
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
IntroductionDefining entriesCreate new or edit existing privileges
IntroductionArtifact detailsCreate new or edit existing artifactsArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositories
Database configuration
IntroductionCreate new or edit existing configurationsDefect tracking reports
IntroductionCreate new or edit existing email configurationsEmail notifiers
Event log
IntroductionJob configurationShortcutsJobs quick view
IntroductionCloudBees CD/RO job detailsJob step details
IntroductionView licenseImport license
IntroductionProcedure runsCreate new or edit existing procedureCreate new or edit existing stepsPublish artifact version stepsRetrieve artifact version stepsSend email stepsExtract preflight sources stepsCreate new or edit existing parameters
IntroductionCreate new or edit existing projectsProject detailsCreate new or edit existing schedulesCreate new or edit existing credentials
IntroductionNested Property Sheet
Reports
IntroductionResource poolsCreate new or edit existing poolsResource pool detailsZonesGateways
IntroductionSearch resultsEdit existing property settings
IntroductionCreate new or edit existing configurations
IntroductionUsersCreate new or edit existing local usersUser detailsEdit user settingsGroupsCreate new or edit existing groupsGroup detailsDirectory providersCreate new or edit existing directory providersSingle sign-onTest directory provider
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
IntroductionCreate new or edit existing workspacesWorkspace file

Installing CloudBees CD/RO plugins

2 minute read

Plugins can be installed from any of the following locations:

  • The Installed plugins tab on the Plugin management page in CloudBees CD/RO. From the Installed plugins tab, you can install a plugin from a file that is on the CloudBees CD/RO server host or from a URL.

  • The Plugins catalog tab on the Plugin management page in CloudBees CD/RO.

  • The CloudBees CD/RO plugins page at docs.cloudbees.com/plugins/cd.

Installing a plugin from a file

If you downloaded a plugin jar file to the server host, you can then install the file from the plugin manager.

To install a plugin from a file:

  1. From the main menu, select DevOps Essentials  Plugin Management  Installed plugins.

  2. On the Installed plugins tab, select Install plugin.

  3. In the Install plugin window, select File install.

  4. Select Choose file to locate and select the plugin’s jar file in your local directory.

  5. (Optional) If a plugin of the same name is already installed and you want to overwrite it with the new plugin, select Disable plugin version check.

  6. Select Install.

    If this option is not available, you might not have the access control permissions to install a plugin.

    The server has a configurable maximum file upload size that defaults to 50 MB. Adjust the Maximum upload size setting on the server if a larger file upload size is needed.

Installing a plugin by using a URL

If you know the URL of a plugin you want to install, you can install it with the URL install option in the plugin manager.

To install a plugin by using a URL:

  1. From the main menu, select DevOps Essentials  Plugin Management  Installed plugins.

  2. On the Installed plugins tab, select Install plugin.

  3. In the Install plugin window, select URL install.

  4. In the blank field, type the URL for the plugin you want to install. For example, https://downloads.cloudbees.com/cloudbees-cd/plugins/EC-Git/latest/EC-Git.jar.

  5. (Optional) If a plugin of the same name is already installed, and you want to overwrite it with the new plugin, select Disable plugin version check.

  6. Select Install.

    If this option is not available, you may not have the access control permissions to install a plugin.

    The server has a configurable maximum file upload size that defaults to 50 MB. Adjust the Maximum upload size setting on the server if a larger file upload size is needed.

Installing a plugin from the plugin catalog

The plugin catalog contains a list of all the available plugins for CloudBees CD/RO. You can search the plugin catalog for a plugin, and then install it from the catalog.

To install a plugin from the plugin catalog:

  1. From the main menu, select DevOps Essentials  Plugin Management  Plugins catalog.

  2. On the Plugins catalog tab, locate the plugin you want to install, and then select Install.

Installing a plugin from the CloudBees CD/RO plugins page

The CloudBees documentation site includes the Plugins tab, where you can search for plugins. After locating a plugin, you can then download it.

  1. Go to CloudBees CD/RO plugins.

  2. In Search plugins, type the name of the plugin you want to install.

  3. Select the box for the plugin.

  4. On the plugin’s detail page, select Download Plugin.

  5. Select the downloaded jar file to install it.

Introduction
Creating configurations