clusterctl 개요

1 개요

Overview of clusterctl
clusterctl 개요

The clusterctl CLI tool handles the lifecycle of a Cluster API management cluster.

The clusterctl command line interface is specifically designed for providing a simple “day 1 experience” and a quick start with Cluster API. It automates fetching the YAML files defining provider components and installing them.

Additionally it encodes a set of best practices in managing providers, that helps the user in avoiding mis-configurations or in managing day 2 operations such as upgrades.

Below you can find a list of main clusterctl commands:

  • clusterctl init Initialize a management cluster.
  • clusterctl upgrade plan Provide a list of recommended target versions for upgrading Cluster API providers in a management cluster.
  • clusterctl upgrade apply Apply new versions of Cluster API core and providers in a management cluster.
  • clusterctl delete Delete one or more providers from the management cluster.
  • clusterctl generate cluster Generate templates for creating workload clusters.
  • clusterctl generate yaml Process yaml using clusterctl’s yaml processor.
  • clusterctl get kubeconfig Gets the kubeconfig file for accessing a workload cluster.
  • clusterctl move Move Cluster API objects and all their dependencies between management clusters.
  • clusterctl alpha rollout Manages the rollout of Cluster API resources. For example: MachineDeployments.

For the full list of clusterctl commands please refer to commands.

1.1 GitHub 레이트 제한 회피

GitHub에서 호스팅되는 제공자를 사용하는 동안, clusterctl은 레이트 제한된 GitHub API를 호출합니다. 일반적인 사용에는 프리 티어면 충분하지만 clusterctl을 광범위하게 사용하면 사용자가 레이트 제한에 도달할 수 있습니다.

퍼블릭 리포에 대한 레이트 제한을 피하려면 GITHUB_TOKEN 환경변수를 세팅하십시오. 토큰을 생성하려면 이 문서를 따르세요. 토큰에는 clusterctl를 위한 repo 스코프만 필요합니다.

기본적으로 clusterctl은, GitHub API에 대한 추가 API 호출을 방지하기 위해, Go 프록시를 사용하여 사용가능한 버전을 감지합니다. go 자체에 대한 GOPROXY 변수(기본값은 https://proxy.golang.org )를 사용하여 go 프록시 URL을 설정할 수 있습니다. GitHub 클라이언트로 즉시 대체하고 go 프록시를 사용하지 않으려면 환경변수를 GOPROXY=off 또는 GOPROXY=direct로 설정할 수 있습니다. 제공자가 Go의 시맨틱 버저닝을 따르지 않으면, clusterctl이 올바른 버전을 감지하는 데 실패할 수 있습니다. 이러한 경우 GOPROXY=off를 통해 Go 프록시 기능을 비활성화하는 것을 고려해야 합니다.

2 clusterctl 설치

Instructions are available in the Quick Start.

3 참고

문서 댓글 ({{ doc_comments.length }})
{{ comment.name }} {{ comment.created | snstime }}