Introduction
Introduction
IntroductionInstall CloudBees CD/RO within KubernetesConfigure Helm chartsKubernetes platform-specific configurationsKubernetes configuration optionsScale build resources manually using a procedureConfigure IP protocols for Helm chart componentsConfigure GitOps with Helm chartsVerify Helm chartsCreate custom Docker imagesVerify Docker images
IntroductionInstallation user requirementsInstallation typesDefault installation directoriesVerify installation binariesAgent security recommendations
IntroductionInstall a default configurationInstall a custom configurationInstall an express agent (full installer)Install an express agent (agent-only installer)Install an advanced agent (agent installer)Install CloudBees Analytics
IntroductionInstall a default configurationInstall a custom configurationInstall an express agent (full installer)Express agent command-line installation (agent-only installer)Advanced command-line installation (agent-only installer)Install CloudBees Analytics
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 usersEdit user settingsCreate and manage groupsPersonasConfigure 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 OpenSearch Dashboards 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/ROObject types 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 tasksDefine manual 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 planning, scheduling, and trackingRelease 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
IntroductionManage service catalogsManage service catalog itemsManage custom filters for catalogs and catalog items
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 stepsExample: 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
IntroductionArtifactsArtifact versionsRepositories
Create object tagsCreate object schedules
IntroductionConfigure webhook triggersConfigure polling triggers
IntroductionConfigure email notificationsSelect and edit email messages for application or microservice processes
Introduction
IntroductionInstall CloudBees CD/RO pluginsCreate plugin configurationsManage pluginsCreate pluginsManage the plugin catalog

Manage service catalogs

6 minute readExtensibility

Service catalogs are managed from the Service catalog  Catalogs page. The Catalogs page contains the following elements:

Service catalog-Catalogs page
Figure 1. Catalogs page

  1. Catalog items and Catalogs tabs:

    • Select the Catalog items tab to view the items for the current filter settings.

    • Select the Catalogs tab to view the catalogs list and access catalog options.

  2. Search field:

    • Enter a query to return results based on the current filters.

  3. Default filters:

    • Select the Projects Projects icon to filter results by projects.

    • Select the Tags Tags icon to filter results by custom tags. For more information on custom tags, refer to Manage catalog tags.

  4. Catalogs list:

    • A list of catalogs for the current search and filter settings.

  5. Project list:

    • The project that each catalog belongs to.

  6. Add catalog button:

    • Select to add and configure a new service catalog.

  7. Filters menu:

    The Default filter displays all catalogs or catalog items, depending on the page. You can refine the results using the Search feature and Default filters (where applicable): Projects, Tags, and Service catalogs, without creating custom filters.

View a catalog

To view an existing catalog, navigate to Service catalog  Catalogs, and then select the catalog name from the list. This opens the catalog page, which contains the following elements:

Catalog page
Figure 2. Catalog page

  1. The name of the catalog and Project.

  2. Catalog tabs:

    • Catalog items: Select to view the items contained in the catalog.

    • Catalog editor: Select to rearrange the layout of catalog items and to edit individual catalog items.

    • DSL editor: Select to view and edit the complete DSL for the catalog.

  3. Search field:

    • Enter a query to return results based on the current filters.

  4. Default filters:

  5. Add catalog item:

    • Select to add new items to the catalog.

  6. Catalog Options menu:

    • Select to manage configurations for the catalog. Options include:

      • Details: Add or edit the title, description, and tags of the catalog.

      • DSL export: Export the catalog as DSL.

      • Access Control: Configure the principals who have access to the catalog.

      • Change History: View what objects have been changed, the type of changes that occurred, who made them, and when they were made.

      • Delete: Permanently delete the catalog.

        Deleting a custom catalog cannot be undone. CloudBees recommends that you create a DSL backup of the catalog before deleting the catalog. For more information, refer to Delete a custom catalog.

  7. Filters menu:

    The Default filter displays all catalogs or catalog items, depending on the page. You can refine the results using the Search feature and Default filters (where applicable): Projects, Tags, and Service catalogs, without creating custom filters.

Create new catalogs

To create a new catalog or copy an existing catalog:

  1. Navigate to Service catalog  Catalogs.

  2. Select the Add catalog button on the right side. This opens the New Catalog window.

  3. Select either:

    • Create new…​ to create a new catalog.

    • Copy existing…​ to create a new catalog based on an existing catalog.

      1. Select a catalog to base the new catalog on.

  4. Enter a catalog title in the Name field.

  5. Select a name from the Project menu.

  6. Enter the catalog information in the Description field.

  7. Select OK.

Edit custom catalogs

The Catalog editor allows you to configure and edit your custom catalog. To access the Catalog editor:

  1. Navigate to Service catalog  Catalogs.

  2. Select the catalog you want to edit from the list. This opens the catalog page.

  3. Select the Catalog editor tab.

The following image shows an example catalog in the Catalog editor, and explains the various features:

Catalog editor
Figure 3. Catalog page

  1. The name of the catalog and Project.

  2. Catalog tabs:

    • Catalog items: Select to view the items that are contained in the catalog.

    • Catalog editor: Select to rearrange the layout of catalog items and to edit individual catalog items.

    • DSL editor: Select to view and edit the complete DSL for the catalog.

  3. Move icon:

    • Select and drag to move catalog items to specific locations in the catalog.

  4. Catalog item Options menu:

    • Select to edit the catalog item.

  5. Add new catalog item button:

    • Select to add a new catalog item.

  6. Catalog Options menu:

    • Select to manage configurations for the catalog. Options include:

      • Details: Add or edit the title, description, and tags of the catalog.

      • DSL export: Export the catalog as DSL.

      • Access Control: Configure the principles who have access to the catalog.

      • Change History: View what object have been changed, the type of changes that occurred, who made them, and when they were made.

      • Delete: Delete the catalog permanently.

        Deleting a custom catalog cannot be undone. CloudBees recommends that you create a DSL backup of the catalog before deleting the catalog. For more information, refer to Delete a custom catalog.

Manage catalog tags

You can manage tags from the catalog Details menu.

To add or delete tags:

  1. Navigate to Service catalog  Catalogs.

  2. Select the appropriate catalog from the list. This opens the catalog page.

  3. Select the catalog Options menu on the right side, and then select Details. This opens the Edit Catalog window.

  4. In the Tags section, select the Tags icon. This opens the Tags window.

  5. To manage tags:

    • To add a new tag, enter a tag name.

    • To delete a tag, select the X button.

      Tags cannot be edited. To fix an issue with an existing tag, you must delete the tag and create a new one.

  6. Select OK.

Export catalogs

CloudBees CD/RO provides options to export your service catalogs in Groovy and YAML DSL.

To export a service catalog:

  1. Navigate to Service catalog  Catalogs.

  2. Select the custom catalog you want to delete. This opens the catalog page.

  3. On the right side of the screen, select the item Options menu.

  4. Select DSL Export. This opens the Export DSL window.

  5. Select your preferences for:

    • DSL format

    • Options for exporting DSL

    • Options for child objects

  6. Once you have selected your preferences, select Export to download the DSL.

Manage catalog ACLs

CloudBees CD/RO provides options to manage who has access to specific catalogs using access control lists (ACLs). ACL principles for catalogs can be set for:

  • Users

  • Groups

  • Plugins

  • Service accounts

  • Projects

To manage the ACLs for a catalog:

  1. Navigate to Service catalog  Catalogs.

  2. Select the custom catalog you want to update. This opens the catalog page.

  3. On the right side of the screen, select the item Options menu.

  4. Select Access Control. This opens the Access Control window:

    catalog access control menu

    The following elements can be used to manage the ACLs:

  1. The Add new icon:

    • Select to add a new principal to the catalog.

      The principal you are trying to add must already exist in the platform. For more information, refer to Access control.

  2. Item-specific access list:

    • The list of principals that have been granted access to the catalog.

  3. The principal Options menu:

    • Options include:

      • Edit: Select to make changes to existing ACL permissions.

      • Delete: Select to remove the principal.

  4. Inherited Privileges:

    • These are the access privileges inherited by the catalog through project and system settings.

  5. Break Inheritance button:

Delete a custom catalog

To delete a custom catalog:

Some catalogs are automatically included with CloudBees CD/RO, and cannot be deleted.

  1. Navigate to Service catalog  Catalogs.

  2. Select the custom catalog you want to delete. This opens the catalog item view of the catalog.

  3. On the right side of the screen, select the item Options menu.

  4. Select Delete. This opens the Delete Catalog? dialog.

  5. To delete the catalog, select OK.

    This action cannot be undone, and once deleted the catalog cannot be recovered. You can export a copy of the catalog DSL before deleting it, which enables recreating it if needed in the future. To export the catalog DSL, refer to Export catalogs.
Introduction
Manage service catalog items