Civo DeployKF

Introduction

This project provides a Terraform configuration to set up a DeployKF on a Civo Kubernetes cluster.

Prerequisites

• Civo account with API key
• Terraform installed on your system
• Kubernetes client (e.g., Lens, kubectl, k9s etc) for interacting with the cluster

Infrastructure Setup

To set up and deploy the Kubernetes cluster, follow these steps:

1. Create vars.tfvars from the template:

civo_token = "your_civo_api_key"
region     = "your_civo_region"  # Change to your preferred region. Default is "LON1".

Replace "your_civo_api_key" with your actual Civo API key.

2. Initialize Terraform:

terraform init

3. Plan the Terraform configuration:

terraform plan --var-file="vars.tfvars"

4. Apply the Terraform configuration:

terraform apply --var-file="vars.tfvars"

5. Retrieve the kubeconfig from the Civo dashboard and load it into kubecontext.

Deploying DeployKF

DeployKF is deployed through ArgoCD, which is already installed on the cluster provisioned through Terraform. You can access the ArgoCD Web UI to see the DeployKF application being deployed. This is optional but recommended to see if anything goes wrong during the deployment.

You can first expose the ArgoCD service by patching the service to use a LoadBalancer:

kubectl patch svc argocd-server -n argocd -p '{"spec": {"type": "LoadBalancer"}}'

You can then access ArgoCD using the LoadBalancer IP address. The default username is admin, and the password can be retrieved using:

echo $(kubectl -n argocd get secret/argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d)

1. Apply the Kyverno configuration:

kubectl apply -f kyverno.yaml

2. Apply the DeployKF configuration:

kubectl apply -f deploykf-values.yaml

After this step you should see a deploykf App of Apps application in the ArgoCD UI.

3. Run the ArgoCD apps sync script:

bash sync_argocd_apps.sh

Troubleshooting

• Common issues and their solutions will be documented here. For more information on troubleshooting DeployKF, please refer to the official documentation.

Configuration Files

• vars.tfvars: Contains the Civo API key and other variables for Terraform.
• kyverno.yaml: Configuration for Kyverno, a Kubernetes policy engine.
• deploykf-values.yaml: Configuration for DeployKF, a Kubernetes deployment tool.

Contributing and Support

• Contributions are welcome. Please submit pull requests or issues on our GitHub repository.
• For support, please contact raise a GitHub issue in this repository.