> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Converge Hetzner external cloud provider

> Store external_cloud_provider=true on every Kubernetes node definition of a Hetzner k3s cluster whose definitions say false while its nodes already run for the hcloud cloud controller manager (a cluster created by the Python lane). The flag is an instruction to the day-2 lanes, so it is only written when EVERY node, read from the platform's node census (the k8s-sync mirror, nodes seen in the last 30 minutes), already carries the external shape: the kubelet argument cloud-provider=external in its k3s.io/node-args annotation, on a k3s server also --disable-cloud-controller and servicelb disabled, and an hcloud:// providerID. Only the stored definitions change: no node is restarted, re-tainted or re-registered and no job is dispatched. Anything else answers 409 with a detail message naming each node to remediate first and why; a node the census cannot vouch for (no fresh node at all, a node missing from the census, a node without a readable k3s.io/node-args annotation, a Kubernetes node resource that is not up or has no stored definition) is refused the same way rather than assumed wired. The other invalid states (a cluster of another provider or distribution, no Kubernetes node resources, a node update, version upgrade or node restart in progress) also answer 409. A cluster whose definitions already all say true answers 200 without reading the census.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/clusters/hetzner/{cluster_id}/external-cloud-provider/converge
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: Pipeline definitions and the approval of the authority they declare.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/clusters/hetzner/{cluster_id}/external-cloud-provider/converge:
    post:
      tags:
        - Hetzner Clusters
      summary: Converge Hetzner external cloud provider
      description: >-
        Store external_cloud_provider=true on every Kubernetes node definition
        of a Hetzner k3s cluster whose definitions say false while its nodes
        already run for the hcloud cloud controller manager (a cluster created
        by the Python lane). The flag is an instruction to the day-2 lanes, so
        it is only written when EVERY node, read from the platform's node census
        (the k8s-sync mirror, nodes seen in the last 30 minutes), already
        carries the external shape: the kubelet argument cloud-provider=external
        in its k3s.io/node-args annotation, on a k3s server also
        --disable-cloud-controller and servicelb disabled, and an hcloud://
        providerID. Only the stored definitions change: no node is restarted,
        re-tainted or re-registered and no job is dispatched. Anything else
        answers 409 with a detail message naming each node to remediate first
        and why; a node the census cannot vouch for (no fresh node at all, a
        node missing from the census, a node without a readable k3s.io/node-args
        annotation, a Kubernetes node resource that is not up or has no stored
        definition) is refused the same way rather than assumed wired. The other
        invalid states (a cluster of another provider or distribution, no
        Kubernetes node resources, a node update, version upgrade or node
        restart in progress) also answer 409. A cluster whose definitions
        already all say true answers 200 without reading the census.
      operationId: >-
        converge_hetzner_external_cloud_provider_endpoint_api_v1_clusters_hetzner__cluster_id__external_cloud_provider_converge_post
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            format: uuid
            title: Cluster Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCloudProviderConvergenceResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '409':
          description: Invalid state
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ExternalCloudProviderConvergenceResult:
      properties:
        external_cloud_provider:
          title: External Cloud Provider
          type: boolean
          description: >-
            What every Kubernetes node definition of the cluster now stores:
            always true.
        converged_resource_ids:
          items:
            type: string
          title: Converged Resource Ids
          type: array
          description: The Kubernetes node resources this call flipped from false.
        already_external_resource_ids:
          items:
            type: string
          title: Already External Resource Ids
          type: array
          description: The Kubernetes node resources that already stored true.
        verified_node_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Verified Node Count
          description: >-
            How many nodes the census found running for the hcloud cloud
            controller manager; null when no definition needed flipping and the
            census was not read.
        applies:
          title: Applies
          type: string
          description: >-
            What the convergence changed, and that it restarted, re-tainted and
            re-registered nothing.
      required:
        - external_cloud_provider
        - converged_resource_ids
        - already_external_resource_ids
        - verified_node_count
        - applies
      title: ExternalCloudProviderConvergenceResult
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````