Skip to content

Latest commit

 

History

History
198 lines (162 loc) · 6.44 KB

deployment.md

File metadata and controls

198 lines (162 loc) · 6.44 KB

STACKIT Cloud Provider Deployment Documentation

Table of Contents

Overview

The STACKIT Cloud Provider includes both the Cloud Controller Manager (CCM) for managing cloud resources and the CSI driver for persistent storage. This deployment provides a unified solution for cloud integration and storage provisioning.

Deployment Components

The deployment consists of the following components:

  1. ServiceAccount: stackit-cloud-controller-manager with appropriate RBAC permissions
  2. Deployment: Runs the cloud provider container with necessary configuration
  3. Service: Exposes metrics and API endpoints

Deployment Configuration

The deployment can be customized using the following flags:

Cloud Controller Manager Flags

  • --cloud-provider=stackit: Set the cloud provider to STACKIT.
  • --webhook-secure-port=0: Disable cloud provider webhook.
  • --concurrent-service-syncs=3: The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load.
  • --controllers=service-lb-controller: Enable specific controllers.
  • authorization-always-allow-paths
  • --leader-elect=true: Enable leader election, see Kube Controller Manager.
  • --leader-elect-resource-name=stackit-cloud-controller-manager: Set leader election resource name, see Kube Controller Manager.

CSI Driver Flags

  • --endpoint: CSI endpoint URL
  • --cloud-config: Path to cloud configuration file
  • --cluster: Cluster identifier
  • --http-endpoint: HTTP server endpoint for metrics
  • --provide-controller-service: Enable controller service (default: true)
  • --provide-node-service: Enable node service (default: true)

Deployment Steps

Apply the deployment using kustomize:

kubectl apply -k deploy/cloud-controller-manager

Example Deployment

Here's an example of a complete deployment configuration:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: stackit-cloud-controller-manager
  namespace: kube-system
spec:
  replicas: 2
  selector:
    matchLabels:
      app: stackit-cloud-controller-manager
  template:
    metadata:
      labels:
        app: stackit-cloud-controller-manager
    spec:
      serviceAccountName: stackit-cloud-controller-manager
      containers:
      - name: stackit-cloud-controller-manager
        image: ghcr.io/stackitcloud/cloud-provider-stackit/cloud-controller-manager:release-v1.34
        args:
        # CCM flags
        - --cloud-provider=stackit
        - --webhook-secure-port=0
        - --concurrent-service-syncs=3
        - --controllers=service-lb-controller
        - --authorization-always-allow-paths=/metrics
        - --leader-elect=true
        - --leader-elect-resource-name=stackit-cloud-controller-manager
        # CSI flags
        - --endpoint=unix:///csi/csi.sock
        - --cloud-config=/etc/config/cloud.yaml
        - --cluster=my-cluster-id
        - --provide-controller-service=true
        - --provide-node-service=true
        env:
        - name: STACKIT_SERVICE_ACCOUNT_KEY_PATH
          value: /etc/serviceaccount/sa_key.json
        ports:
        - containerPort: 10258
          hostPort: 10258
          name: https
          protocol: TCP
        - containerPort: 9090
          hostPort: 9090
          name: metrics
          protocol: TCP
        resources:
          limits:
            cpu: "0.5"
            memory: 500Mi
          requests:
            cpu: "0.1"
            memory: 100Mi
        volumeMounts:
        - mountPath: /etc/config
          name: cloud-config
        - mountPath: /etc/serviceaccount
          name: cloud-secret
      volumes:
      - name: cloud-config
        configMap:
          name: stackit-cloud-config
      - name: cloud-secret
        secret:
          secretName: stackit-cloud-secret

Configuration Options

Cloud Configuration

The cloud configuration file should be mounted at /etc/config/cloud.yaml and contain the necessary credentials and settings for accessing STACKIT services.

Example cloud configuration:

# cloud.yaml
global:
  projectId: your-project-id
  region: eu01
loadBalancer:
  networkId: your-network-id
kubectl create configmap -n kube-system stackit-cloud-secret --from-files=cloud.yaml

Parameters

  • projectId: (Required) Your STACKIT Project ID. The CCM will manage resources within this project.
  • networkId: (Required) The STACKIT Network ID. This is used by the CCM to configure load balancers (Services of type=LoadBalancer) within the specified network.
  • region: (Required) The STACKIT region (e.g., eu01) where your cluster and resources are located.
  • extraLabels: (Optional) A map of key-value pairs to add as custom labels to the load balancer instances created by the CCM.
  • loadBalancerApi: (Optional) A map containing settings related to the Load Balancer API.
    • url: (Optional) The URL of the STACKIT Load Balancer API. If not set, this defaults to the production API endpoint. This is typically used for development or testing purposes.

Monitoring and Logging

Metrics

The cloud provider exposes metrics on port 9090. Configure your monitoring system to scrape these metrics for observability.

Example ServiceMonitor configuration for Prometheus Operator:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: stackit-cloud-controller-manager
  namespace: kube-system
  labels:
    release: prometheus
spec:
  selector:
    matchLabels:
      app: stackit-cloud-controller-manager
  endpoints:
    - port: metrics
      interval: 30s
      path: /metrics

Logs

Cloud provider logs can be found in the Kubernetes controller manager pods. Enable verbose logging by setting the log level to debug.

Example log level configuration:

args:
  - --v=4 # Debug log level