Skip to content

Installation

Once you have completed all the prerequisites, you are ready to install and run Klodd.

Deployment Steps

CRD and ClusterRole

Installing CRD and ClusterRole

# Install Klodd Challenge CRD
kubectl apply -f https://raw.githubusercontent.com/TJCSec/klodd/master/manifests/klodd-crd.yaml

# Install Klodd ClusterRole
kubectl apply -f https://raw.githubusercontent.com/TJCSec/klodd/master/manifests/klodd-rbac.yaml

Use the commands above to install the Klodd Challenge CRD and ClusterRole.

Deployment

Klodd is available as a Docker image. Klodd can run outside of a cluster, as long as a kubeconfig is available. However, it is designed to run in the Kubernetes cluster where it will deploy challenges.

Create a ServiceAccount and bind the Klodd ClusterRole to it. Then, create a Deployment for Klodd, and expose it using a Service and Ingress. To configure Klodd, you can store configuration in a Secret, then mount the Secret to the Deployment. An example of all of this is provided here.

Ratelimiting is recommended

Serving Klodd requests can potentially be quite expensive. Though an effort is made to prevent automated requests (using reCAPTCHA), a strict ratelimit is still recommended. Configuring a RateLimit middleware using Traefik is very easy—you can learn how to do this here.

More detailed instructions on configuration are provided here.

Challenges

Each challenge is configured using a custom resource. You can apply these manually, but using a tool like Terraform is highly recommended. More detailed instructions on challenge configuration are provided here.