Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation instructions for metalctl #200

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Add installation instructions for metalctl #200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/usage/metalctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# metalctl

## move
## Installation

Install the `metalctl` CLI from source without cloning the repository. Requires [Go](https://go.dev) to be installed.

```bash
go install https://github.com/ironcore-dev/metal-operator/cmd/metalctl@latest
```

## Commands

### move

The `metalctl move` command allows to move the metal Custom Resources, like e.g. `Endpoint`, `BMC`, `Server`, etc. from one
cluster to another.
Expand Down Expand Up @@ -34,7 +44,7 @@ several limitation for this scenario, like e.g. the implementation assumes the c
move operation, and possible race conditions happening while the cluster is upgrading, scaling up, remediating etc. has
never been investigated nor addressed.

### Pivot
#### Pivot

Pivoting is a process for moving the Custom Resources and install Custom Resource Definitions from a source cluster to
a target cluster.
Expand All @@ -44,7 +54,7 @@ This can now be achieved with the following procedure:
1. Use `make install` to install the metal Custom Resource Definitions into the target cluster
2. Use `metalctl move` to move the metal Custom Resources from a source cluster to a target cluster

### Dry run
#### Dry run

With `--dry-run` option you can dry-run the move action by only printing logs without taking any actual actions. Use
`--verbose` flag to enable verbose logging.
Loading