Installation Guide for K8-OS

Note: All steps up to step 11 can run independently (in parallel). The steps after that proceed sequentially.

1. Domain names must be determined, and DNS records must be configured. [ Kubernetes | OpenShift ]
2. If the IP address that DNS will resolve to is not known in advance for the cluster, we need to wait for the “ingress” to be created during installation to obtain the IP that DNS will resolve. [ Kubernetes | OpenShift ]
3. An SSL certificate covering the determined domain names must be prepared. [ Kubernetes | OpenShift ]
4. The cluster must have an “ingress controller” ready. [ Kubernetes ]
5. A “namespace” is created in the cluster for the Appcircle server. [ Kubernetes | OpenShift ]
6. Settings must be made to allow container images to be pulled. [ Kubernetes | OpenShift ]
7. SMTP settings to be used in the Appcircle server must be ready, and access from the cluster to the SMTP server must be configured. [ Kubernetes | OpenShift ] — Optional
8. “Relational database” settings for the IAM service must be ready, and access from the cluster to the database server must be configured. [ PostgreSQL ] -- Authentication Service Integrations
9. MongoDB settings for Appcircle services must be ready, and access from the cluster to the MongoDB server must be configured. [ MongoDB ] -- External Services that Appcircle Server depends on
10. HashiCorp Vault settings for Appcircle services must be ready, and access from the cluster to the HashiCorp Vault service must be configured. [ HashiCorp Vault ] -- External Services that Appcircle Server depends on
11. S3-compatible storage settings for Appcircle services must be ready, and access from the cluster to the S3-compatible storage service must be configured. [ S3-compatible Storage | AWS S3 | GCP Cloud Storage ] -- External Services that Appcircle Server depends on
12. If the services that the Appcircle server will integrate with (e.g., Git provider, SMTP, LDAP, Proxy server, etc.) are using “self-signed certificates,” those service certificates must be ready to be trusted. [ CA Certificates ]
13. Once the previous steps are completed, a configuration file is prepared using the outputs of these steps. [ Kubernetes | OpenShift ]
14. The Appcircle chart is pulled from the Helm repository for the Appcircle server installation. [ Kubernetes | OpenShift ]
15. The Appcircle server is installed using the configuration file and the pulled chart. [ Kubernetes | OpenShift ]
16. After installation, the license prepared by Appcircle is updated in the application. [ License ]
17. If Appcircle runner installation has been performed, the runners are connected to the Appcircle server. [ Connecting Runners ]
18. If the Enterprise Portal and Testing Portal services are to be installed on a DMZ cluster, a configuration file is prepared for this and the installation is performed on the DMZ cluster. Access from the DMZ cluster to the cluster where the Appcircle server is installed must be configured.