# Kubernetes Deployments

[TOC]

## Using Helm Chart to deploy your CodiMD instance into kubernetes

CodiMD has helm chart on [](https://artifacthub.io/packages/helm/codimd/codimd)

### Requirements

- Kubernetes >= 14.0.0
- Helm 2 / 3

$ helm repo add codimd https://helm.codimd.dev/
$ helm repo update
$ helm install --name my-codimd codimd/codimd

### Customize you deployment

If you use AWS EKS, need to setup `storageClass` to `gp2`.

storageClass: 'gp2'

service:
  type: "ClusterIP"

ingress:
  enabled: true
  hostname: my-codimd.example.com
  annotation:
    cert-manager.io/cluster-issuer: letsencrypt-production
    kubernetes.io/ingress.class: nginx
  tlsSecret: ssl-secret

codimd:
  connection:
    domain: my-codimd.example.com
    protocolUseSSL: true
  security:
    sessionSecret: "EiC2oasdfsahxi"
  imageUpload:
    storeType: imgur
  imageStorePersistentVolume:
    enabled: true