Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-cluster-management-io/clusteradm
command line tool to bootstrap open-cluster-management control plane.
https://github.com/open-cluster-management-io/clusteradm
Last synced: 2 days ago
JSON representation
command line tool to bootstrap open-cluster-management control plane.
- Host: GitHub
- URL: https://github.com/open-cluster-management-io/clusteradm
- Owner: open-cluster-management-io
- License: apache-2.0
- Created: 2021-05-20T14:43:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T01:45:14.000Z (2 months ago)
- Last Synced: 2024-10-25T02:45:30.922Z (2 months ago)
- Language: Go
- Size: 28.8 MB
- Stars: 79
- Watchers: 7
- Forks: 63
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[comment]: # ( Copyright Contributors to the Open Cluster Management project )
# clusteradm CLI & CLI Plugin
A CLI and kubernetes CLI plugin that allows you to interact with open-cluster-management to manage your Hybrid Cloud presence from the command-line.
## Quick start
### Install the clusteradm command-line:
#### From install script:
```shell
curl -L https://raw.githubusercontent.com/open-cluster-management-io/clusteradm/main/install.sh | bash
```
#### From go install:
```shell
GO111MODULE=off go get -u open-cluster-management.io/clusteradm/...
```
#### From binaries:
The binaries for several platforms are available [here](https://github.com/open-cluster-management-io/clusteradm/releases).
- Download the compressed file from [here](https://github.com/open-cluster-management-io/clusteradm/releases)
- Uncompress the file and place the output in a directory of your $PATH
#### From source:
Go 1.17 is required in order to build or contribute on this project as it leverage the `go:embed` tip.
The binary will be installed in `$GOPATH/bin`
```bash
git clone https://github.com/open-cluster-management-io/clusteradm.git
cd clusteradm
make build
clusteradm
```
### Initialize a hub and join a cluster
```bash
# Initialize the hub
kubectl config use-context # kubectl config use-context kind-hub
clusteradm init
# Request a managed cluster to join the hub
kubectl config use-context # kubectl config use-context kind-managed-cluster
clusteradm join --hub-token --hub-apiserver --cluster-name
# Accept the managed cluster request on the hub
kubectl config use-context # kubectl config use-context kind-hub
clusteradm accept --clusters # clusteradm accept --clusters c1,c2,...
```
After each above clusteradm command, the clusteradm will print out the next clusteradm command to execute which can be copy/paste.
## Contributing
See our [Contributing Document](CONTRIBUTING.md) for more information.
## Commands
The commands are composed of a verb and a noun and then a number of parameters.
Logs can be gather by setting the klog flag `-v`.
To get the logs in a separate file:
```
clusteradm -v 2 >
```
or
```
clusteradm -v 99 --logtostderr=false --log-file=
```
### version
Display the clusteradm version and the kubeversion
`clusteradm version`
### init
Initialize the hub by deploying the hub side resources to manage clusters.
`clusteradm init [--use-bootstrap-token]`
it returns the command line to launch on the spoke to join the hub.
> NOTE: Do not run init command against a [multicluster-controlplane](https://github.com/open-cluster-management-io/multicluster-controlplane) instance. It is already an initialized hub on start. Instead, use `clusteradm get token --use-bootstrap-token` to get the join command.
### get token
Get the latest token to import a new managed cluster.
`clusteradm get token --context ${CTX_HUB_CLUSTER}`
### join
Install the agent on the spoke.
`clusteradm join --hub-token --hub-apiserver --cluster-name c1 [--ca-file ] [--force-internal-endpoint-lookup]`
it returns the command line to launch on the hub the accept the spoke onboarding.
> NOTE: The `--ca-file` flag is used to provide a valid CA for hub. The ca data is fetched from cluster-info configmap in kube-public namespace of the hub cluster, then from kube-root-ca.crt configmap in kube-public namespace if the cluster-info configmap does not exist.
> NOTE: If you're trying to join a hub cluster which is initialized from a kind cluster, please set the `--force-internal-endpoint-lookup` flag.
### accept
Accept the CSRs on the hub to approve the spoke clusters to join the hub.
`clusteradm accept --clusters , ,....`
### unjoin
Uninstall the agent on the spoke
`clusteradm unjoin --cluster-name c1`
> Note: the applied resources on managed cluster would be checked and prompt a warning if still exist any.
### clean
Clean up the multicluster hub control plane and other initialized resources on the hub cluster
`clusteradm clean --context ${CTX_HUB_CLUSTER}`
### install hub-addon
Install specific built-in add-on(s) to the hub cluster.
`clusteradm install hub-addon --names application-manager`
`clusteradm install hub-addon --names governance-policy-framework`
### enable addons
Enable specific add-on(s) agent deployment to the given managed clusters of the specified namespace
`clusteradm addon enable --names application-manager --namespace --clusters ,,....`
`clusteradm addon enable --names governance-policy-framework --namespace --clusters ,,....`
`clusteradm addon enable --names config-policy-controller --namespace --clusters ,,....`
### create sample application
Create and Deploy a Sample Subscription Application
`clusteradm create sampleapp sampleapp1`