Skip to main content

helmchart Application Deployment

This document provides a standardized reference for deploying applications in our Kubernetes cluster. It outlines the essential file structure, configuration parameters, and optional components needed for consistent application deployment.

info

All applications should follow this base template. Optional components can be added based on specific application requirements such as database integration, authentication, or custom configurations.

Directory Structure​

The following directory structure represents the standard layout for application deployment:

<application-name>/
├── externalsecret.yaml    # If secrets are needed
├── http-route.yaml        # Gateway API routing
├── kustomization.yaml     # Required
└── values.yaml           # If using Helm

Core Components​

kustomization.yaml​

  • Description: Main configuration file that defines how the application should be deployed and customized

  • Type: yaml

  • Required: Yes

  • Example:

    apiVersion: kustomize.config.k8s.io/v1beta1
    kind: Kustomization
    namespace: <app-name>

    resources:
      - http-route.yaml
      # Add other resources as needed

    generatorOptions:
      disableNameSuffixHash: true

    helmCharts:
      - name: <chart-name>
        repo: <helm-repo-url>
        version: <version>
        releaseName: <app-name>
        namespace: <app-name>
        valuesFile: values.yaml

http-route.yaml​

  • Description: Defines how traffic should be routed to the application

  • Type: yaml

  • Required: Yes

  • Example:

    apiVersion: gateway.networking.k8s.io/v1
    kind: HTTPRoute
    metadata:
      name: <app-name>
      namespace: <app-name>
    spec:
      parentRefs:
        - name: external
          namespace: gateway
      hostnames:
        - "<app-name>.pc-tips.se"
      rules:
        - matches:
            - path:
                type: PathPrefix
                value: /
          backendRefs:
            - name: <app-name>
              port: <port>

externalsecret.yaml​

  • Description: Configuration for external secrets management using Bitwarden backend

  • Type: yaml

  • Required: No

  • Example:

    apiVersion: external-secrets.io/v1
    kind: ExternalSecret
    metadata:
      name: <app-name>-credentials
      namespace: <app-name>
    spec:
      refreshInterval: 1h
      secretStoreRef:
        name: bitwarden-backend
        kind: ClusterSecretStore
      target:
        name: <app-name>-credentials
        creationPolicy: Owner
      data:
        - secretKey: <key-name>
          remoteRef:
            key: <bitwarden-secret-id>

Optional Components​

Authentication Integration​

  • Description: Configuration for integrating with Authentik authentication proxy

  • Type: yaml

  • Required: No

  • Example:

    apiVersion: gateway.networking.k8s.io/v1
    kind: HTTPRoute
    metadata:
      name: <app-name>-auth
      namespace: <app-name>
    spec:
      parentRefs:
        - name: external
          namespace: gateway
      rules:
        - backendRefs:
            - name: authentik-proxy
              namespace: auth
              port: 9000

Reference Grant​

  • Description: Enables cross-namespace routing capabilities

  • Type: yaml

  • Required: No (Only when cross-namespace communication is needed)

  • Example:

    apiVersion: gateway.networking.k8s.io/v1beta1
    kind: ReferenceGrant
    metadata:
      name: allow-<source>-to-<target>
      namespace: <target-namespace>
    spec:
      from:
        - group: gateway.networking.k8s.io
          kind: HTTPRoute
          namespace: <source-namespace>
      to:
        - group: ""
          kind: Service
          name: <target-service>

Database Integration​

  • Description: PostgreSQL database configuration using Zalando operator

  • Type: yaml

  • Required: No

  • Example:

    apiVersion: "acid.zalan.do/v1"
    kind: postgresql
    metadata:
      name: <app-name>-postgresql
      namespace: <app-name>
    spec:
      teamId: "<team>"
      volume:
        size: <size>
      numberOfInstances: 1
      resources:
        requests:
          cpu: 100m
          memory: 256Mi
        limits:
          cpu: 500m
          memory: 512Mi

ConfigMap Generator​

  • Description: Generates ConfigMaps for application configuration

  • Type: yaml

  • Required: No

  • Example:

    configMapGenerator:
      - name: <app-name>-config
        literals:
          - TZ=Europe/Stockholm
          # Add other configuration