Welcome
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan client and server software.
Getting started with DevOps Plan Helm Chart
This quick start guide shows you how to deploy DevOps Plan Helm Chart.
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.

Overview
Learn general information about the product.
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan client and server software.
- 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 schema repositories and user databases are types of databases that are physically managed by a database management system, such as PostgreSQL.
- Getting started with DevOps Plan Helm Chart
  This quick start guide shows you how to deploy DevOps Plan Helm Chart.
  - 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.
  - DevOps Plan Helm chart reference
    Information about using the DevOps Plan Helm chart.
  - 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 rolling upgrades to DevOps Plan Helm chart
    You can upgrade DevOps Plan to the newest release using the helm upgrade command.
  - Performing rolling roll back to DevOps Plan Helm chart
    You can roll back DevOps Plan to the previous release using the helm rollback command.
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.

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.

Procedure

Enable Keycloak Single Sign on by using external Keycloak running outside of the helm chart:

To use an external Keycloak instance to enable the Keycloak Single Sign On feature:
1. Access the Keycloak Administration URL to create a new client and download the keycloak.json file:
  1. Go to the new client page, click Action and select Download adapter config to download the keycloak.json file.
  2. Edit and add the following line to the keycloak.json file:
```
"disable-trust-manager": true
```
2. Create a keycloak-json configMap for the keycloak.json file:
  1. Create a new folder named path/to/your/keycloak that contains the keycloak.json file for installing and configuring Keycloak on the devopsplan pod container:
```
$ mkdir /path/to/your/keycloak
```
  2. Add the keycloak.json file from the path/to/your/keycloak folder to the configMap called keycloak-json.
```
$ kubectl create cm keycloak-json --from-file /path/to/your/keystore/keycloak.json --namespace [namespace_name]
```
  3. Ensure that the configMap keycloak-json is created and that it contains the keycloak.json file from the path/to/your/keycloak/ path.
```
$ kubectl get cm keycloak-json -o yaml --namespace [namespace_name]
```
3. Create a file named keycloak.yaml. Enable the Keycloak and SSO configurations for the devopsplan pod container and keycloak.json file.
```
keycloak:
  enabled: true
  service: 
    enabled: false
  urlMapping: [Keycloak_URL]
  username: [Keycloak_Admin_Usename]
  password: [Keycloak_Admin_Password]
  realmName: [Keycloak_Realm_Name]
  dashboardsClientID: [Keycloak_Dashboards_Client_ID]
  dashboardsClientSecret: [Keycloak_Dashboards_Client_Secret]
  jsonFile:
    enabled: true
    configMapName: keycloak-json
```
4. Add -f keycloak.yaml to the helm_install or helm_upgrade command.