Welcome
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan.
Getting started with DevOps Plan Helm Chart
This quick start guide shows you how to deploy DevOps Plan Helm Chart.
DevOps Plan Helm chart reference
Information about using the DevOps Plan Helm chart.
Values for mounting the DevOps Plan Windows package into the REST API Server
Use the following values to enable to disable the DevOps Plan Windows package into the REST API server.

Overview
Learn general information about the product.
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan.
- Hardware, software, and database requirements
  Review the requirements information to identify operating system, file system, and compatibility requirements, prerequisite tasks, and other information that is required to install or upgrade DevOps Plan.
- Vendor database configuration
  DevOps Plan requires a PostGreSQL database to create TeamSpace and Applications.
- Getting started with DevOps Plan Helm Chart
  This quick start guide shows you how to deploy DevOps Plan Helm Chart.
  - Creating the DevOps Plan REST API SSL Certificate
    DevOps Plan uses SSL to secure access to its user interface and REST APIs. A self signed certificate is provided out of the box, but some proxies and gateways will accept self-signed certificates.
  - Installing SSL certificates
    You can install SSL certificates to ensure secure and reliable communication with the DevOps Plan application.
  - Enabling Swagger UI
    By default, the Swagger user interface (UI) is disabled. However, you can enable it two ways: by using the helm install command or by modifying the custom values YAML file.
  - Installing DevOps Plan with external databases and optional email server settings
    DevOps Plan requires a PostgreSQL database to create TeamSpace and Applications. The PostgreSQL database may be running in your cluster or on hardware that resides outside of your cluster. The values used to connect to the database are required when installing DevOps Plan. The DevOps Plan helm chart provides the PostgreSQL database by default settings. You can disable it and use your own PostgreSQL database.
  - Enabling the DevOps Plan Keycloak Single Sign On feature
    By default, the DevOps Plan Helm Chart comes configured with the Keycloak single sign on feature enabled. You can disable the Keycloak that is installed with the helm chart and use an external Keycloak instance that is installed outside of the helm chart.
  - Installing DevOps Plan with Emissary-ingress Load Balancer
    You can install DevOps Plan with Emissary-ingress load balancer when you plan to scale up hcl-devopsplan pods by running multiple instances. The Emissary-ingress load balancer distributes network traffic to all hcl-devopsplan pods. Once you have multiple instances of hcl-devopsplan running, you can perform rolling updates without downtime.
  - Installing DevOps Plan with DevOps Control
    DevOps Control provides Git hosting, code review, and team collaboration. It is similar to GitHub, Bitbucket, and GitLab. DevOps Control is based on the open-source Gitea project.
  - Backing up and restoring Kubernetes Cluster and PVC using Velero and MinIO
    You can configure and use Velero and MinIO to backup and restore your Kubernetes Clusters, including Persistent Volume Claims (PVCs). Velero manages backups while MinIO provides S3-compatible storage.
  - DevOps Plan Helm chart reference
    Information about using the DevOps Plan Helm chart.
    - DevOps Plan analytics feature and dashboards for business analytics helm chart reference
      Business analytics and dashboard support is offered as part of a technical preview. Support will be provided on a best effort basis.
    - DevOps Plan for Single Sign On support with Keycloak
      Single Sign-On support is offered by using Keycloak.
    - Parameters for PostgreSQL, TeamSpace, and Applications
      This topic shows the settings of the PostgreSQL database and the settings for TeamSpace and Application creation.
    - Parameters for Liveness and Readiness
      This topic shows the liveness and readiness parameters for setting up the DevOps Plan helm chart.
    - Values for mounting the DevOps Plan Windows package into the REST API Server
      Use the following values to enable to disable the DevOps Plan Windows package into the REST API server.
  - DevOps Plan persistent volumes
    Learn the default value settings for persistent volumes in DevOps Plan.
  - Updating OpenSearch and OpenSearch Dashboards password
    You can update the OpenSearch Dashboard password.
  - Performing helm upgrades to DevOps Plan
    You can upgrade DevOps Plan to the newest release using the helm upgrade command.
  - Performing helm roll backs to DevOps Plan
    You can roll back DevOps Plan to the previous release using the helm rollback command.
  - Troubleshooting
    Information about troubleshooting errors when deploying DevOps Plan.
Developing
Learn how to develop schemas by using the DevOps Plan Designer.
Integrating
You can integrate DevOps Plan with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.

Values for mounting the DevOps Plan Windows package into the REST API Server

Use the following values to enable to disable the DevOps Plan Windows package into the REST API server.

The below table shows the values and settings to mount the DevOps Plan Windows package into the REST API server.

Note: By default, the DevOps Plan solution Helm chart sets the persistent volume. If your Kubernetes environment does not provide default StorageClass, you must create your own default StorageClass and name it persistence.storageClass. Otherwise, you must set winInstall.enabled=false.

Table 1. Windows package mount settings
Parameter	Description	Default value
winInstall.enabled	This parameter enables mounting the DevOps Plan Windows package in the REST API server. Accepted values are: `True`: enables mounting the DevOps Plan Windows product package. `False`: disables mounting the DevOps Plan Windows product package.	true
winInstall.image.repository	DevOps Plan win-install Docker Image repository path. This parameter is required if `winInstall.enabled=true`.	ccm/hcl-devopsplan-win-install
winInstall.image.tag	DevOps Plan win-install Image tag. This parameter is required if `winInstall.enabled=true`.	3.0.4
winInstall.image.pullPolicy	DevOps Plan win-install image pull policy. This parameter is required if `winInstall.enabled=true`. Accepted values are: IfNotPresent Always	IfNotPresent
winInstall.accessModes	DevOps Plan win-install persistence Volume access modes. This parameter is required if `winInstall.enabled=true`.	ReadWriteOnce
winInstall.size	DevOps Plan win-install persistence Volume size. This parameter is required if `winInstall.enabled=true`.	2Gi
winInstall.reclaimPolicy	DevOps Plan win-install Volume reclaim policy. This parameter is required if `winInstall.enabled=true`.	Retain
winInstall.existingClaim	DevOps Plan win-install persistence Volume existing claim.	""