Skip to content

Deploy your first application

Note

For the purpose of demonstration this guide uses Kind to create a Kubernetes cluster and an OCI registry. We recommend that beginners follow along with both.

  • Navecd
  • Go
  • Kind
  • Docker/Podman

Create Kind Cluster

Set up a local Kubernetes cluster and local OCI registry as documented in https://kind.sigs.k8s.io/docs/user/local-registry/.

Initialize a Navecd GitOps Repository

mkdir mygitops
cd mygitops
# init Navecd gitops repository as a CUE module
export CUE_REGISTRY=ghcr.io/kharf
navecd init github.com/user/mygitops
go mod init mygitops
navecd verify
See CUE module reference for valid CUE module paths.

Install Navecd onto your Kubernetes Cluster

navecd install \
  -u localhost:5001/mygitops \
  -r latest \
  --name dev

Deploy a Manifest and a HelmRelease

Get Go Kubernetes Structs and import them as CUE schemas.

Tip

Use CUE modules and provide the following CUE schemas as OCI artifacts.

go get k8s.io/api/core/v1
cue get go k8s.io/api/core/v1
cue get go k8s.io/apimachinery/pkg/api/resource
cue get go k8s.io/apimachinery/pkg/apis/meta/v1
cue get go k8s.io/apimachinery/pkg/runtime
cue get go k8s.io/apimachinery/pkg/types
cue get go k8s.io/apimachinery/pkg/watch
cue get go k8s.io/apimachinery/pkg/util/intstr
mkdir infrastructure
touch infrastructure/prometheus.cue

Edit infrastructure/prometheus.cue and add:

package infrastructure

import (
    "github.com/kharf/navecd/schema/component"
    corev1 "k8s.io/api/core/v1"
)

// Public Navecd Manifest Component
ns: component.#Manifest & {
    content: corev1.#Namespace & {
        apiVersion: "v1"
        kind:       "Namespace"
        metadata: {
            name: "monitoring"
        }
    }
}

// Public Navecd HelmRelease Component
prometheusStack: component.#HelmRelease & {
    dependencies: [
    // Navecd automatically generates ids for Components, which are used for dependency constraints.
        ns.id,
    ]
    name:      "prometheus-stack"
  // Use namespace name Component reference to reduce redundancy
    namespace: ns.content.metadata.name
    chart: {
        name:    "kube-prometheus-stack"
        repoURL: "https://prometheus-community.github.io/helm-charts"
        version: "x.x.x"
    }
    values: {
        prometheus: prometheusSpec: serviceMonitorSelectorNilUsesHelmValues: false
    }
}

See getting-started example.

navecd verify
navecd push \
  -u localhost:5001/mygitops \
  -r latest