diff --git a/Makefile b/Makefile index 5956b9b5e9..e9bcdb950c 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ .DEFAULT_GOAL := build -RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.17.7") +RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.18.0") ifeq ($(CI),true) DOCKER_TTY_ARG= diff --git a/docs/src/external/metalctl/docs/metalctl_firewall_create.md b/docs/src/external/metalctl/docs/metalctl_firewall_create.md index 42e16c8e3a..32ee95d670 100644 --- a/docs/src/external/metalctl/docs/metalctl_firewall_create.md +++ b/docs/src/external/metalctl/docs/metalctl_firewall_create.md @@ -25,7 +25,7 @@ metalctl firewall create [flags] --filesystemlayout string Filesystemlayout to use during machine installation. [optional] --firewall-rules-file string firewall rules specified in a yaml file - + Example: $ metalctl firewall create ..mandatory args.. --firewall-rules-file rules.yaml diff --git a/docs/src/external/metalctl/docs/metalctl_size.md b/docs/src/external/metalctl/docs/metalctl_size.md index 50a9c8e0ca..6de6a8aa1c 100644 --- a/docs/src/external/metalctl/docs/metalctl_size.md +++ b/docs/src/external/metalctl/docs/metalctl_size.md @@ -51,6 +51,6 @@ a size matches a machine in terms of cpu cores, ram and storage. * [metalctl size imageconstraint](metalctl_size_imageconstraint.md) - manage imageconstraint entities * [metalctl size list](metalctl_size_list.md) - list all sizes * [metalctl size reservations](metalctl_size_reservations.md) - manage size reservations -* [metalctl size try](metalctl_size_try.md) - try a specific hardware spec and give the chosen size back +* [metalctl size suggest](metalctl_size_suggest.md) - suggest size from a given machine id * [metalctl size update](metalctl_size_update.md) - updates the size diff --git a/docs/src/external/metalctl/docs/metalctl_size_try.md b/docs/src/external/metalctl/docs/metalctl_size_suggest.md similarity index 80% rename from docs/src/external/metalctl/docs/metalctl_size_try.md rename to docs/src/external/metalctl/docs/metalctl_size_suggest.md index 424b08eb39..f50120f69c 100644 --- a/docs/src/external/metalctl/docs/metalctl_size_try.md +++ b/docs/src/external/metalctl/docs/metalctl_size_suggest.md @@ -1,18 +1,19 @@ -# metalctl size try +# metalctl size suggest -try a specific hardware spec and give the chosen size back +suggest size from a given machine id ``` -metalctl size try [flags] +metalctl size suggest [flags] ``` ## Options ``` - -C, --cores int32 Cores of the hardware to try - -h, --help help for try - -M, --memory string Memory of the hardware to try, can be given in bytes or any human readable size spec - -S, --storagesize string Total storagesize of the hardware to try, can be given in bytes or any human readable size spec + --description string The description of the suggested size (default "a suggested size") + -h, --help help for suggest + --labels strings labels to add to the size + --machine-id string Machine id used to create the size suggestion. [required] + --name string The name of the suggested size (default "suggested-size") ``` ## Options inherited from parent commands diff --git a/docs/src/external/metalctl/docs/metalctl_switch.md b/docs/src/external/metalctl/docs/metalctl_switch.md index 67ac51adb5..2d07cad029 100644 --- a/docs/src/external/metalctl/docs/metalctl_switch.md +++ b/docs/src/external/metalctl/docs/metalctl_switch.md @@ -50,6 +50,7 @@ switch are the leaf switches in the data center that are controlled by metal-sta * [metalctl switch detail](metalctl_switch_detail.md) - switch details * [metalctl switch edit](metalctl_switch_edit.md) - edit the switch through an editor and update * [metalctl switch list](metalctl_switch_list.md) - list all switches +* [metalctl switch port](metalctl_switch_port.md) - sets the given switch port state up or down * [metalctl switch replace](metalctl_switch_replace.md) - put a leaf switch into replace mode in preparation for physical replacement. For a description of the steps involved see the long help. * [metalctl switch ssh](metalctl_switch_ssh.md) - connect to the switch via ssh * [metalctl switch update](metalctl_switch_update.md) - updates the switch diff --git a/docs/src/external/metalctl/docs/metalctl_switch_port.md b/docs/src/external/metalctl/docs/metalctl_switch_port.md new file mode 100644 index 0000000000..c1e8e0f691 --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_switch_port.md @@ -0,0 +1,46 @@ +# metalctl switch port + +sets the given switch port state up or down + +## Options + +``` + -h, --help help for port + --port string the port to be changed. +``` + +## Options inherited from parent commands + +``` + --api-token string api token to authenticate. Can be specified with METALCTL_API_TOKEN environment variable. + --api-url string api server address. Can be specified with METALCTL_API_URL environment variable. + -c, --config string alternative config file path, (default is ~/.metalctl/config.yaml). + Example config.yaml: + + --- + apitoken: "alongtoken" + ... + + + --debug debug output + --force-color force colored output even without tty + --kubeconfig string Path to the kube-config to use for authentication and authorization. Is updated by login. Uses default path if not specified. + --no-headers do not print headers of table output format (default print headers) + -o, --output-format string output format (table|wide|markdown|json|yaml|template), wide is a table with more columns. (default "table") + --template string output template for template output-format, go template format. + For property names inspect the output of -o json or -o yaml for reference. + Example for machines: + + metalctl machine list -o template --template "{{ .id }}:{{ .size.id }}" + + + --yes-i-really-mean-it skips security prompts (which can be dangerous to set blindly because actions can lead to data loss or additional costs) +``` + +## SEE ALSO + +* [metalctl switch](metalctl_switch.md) - manage switch entities +* [metalctl switch port describe](metalctl_switch_port_describe.md) - gets the given switch port state +* [metalctl switch port down](metalctl_switch_port_down.md) - sets the given switch port state down +* [metalctl switch port up](metalctl_switch_port_up.md) - sets the given switch port state up + diff --git a/docs/src/external/metalctl/docs/metalctl_switch_port_describe.md b/docs/src/external/metalctl/docs/metalctl_switch_port_describe.md new file mode 100644 index 0000000000..fa6b25c354 --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_switch_port_describe.md @@ -0,0 +1,51 @@ +# metalctl switch port describe + +gets the given switch port state + +## Synopsis + +shows the current actual and desired state of the port of the given switch. + +``` +metalctl switch port describe [flags] +``` + +## Options + +``` + -h, --help help for describe +``` + +## Options inherited from parent commands + +``` + --api-token string api token to authenticate. Can be specified with METALCTL_API_TOKEN environment variable. + --api-url string api server address. Can be specified with METALCTL_API_URL environment variable. + -c, --config string alternative config file path, (default is ~/.metalctl/config.yaml). + Example config.yaml: + + --- + apitoken: "alongtoken" + ... + + + --debug debug output + --force-color force colored output even without tty + --kubeconfig string Path to the kube-config to use for authentication and authorization. Is updated by login. Uses default path if not specified. + --no-headers do not print headers of table output format (default print headers) + -o, --output-format string output format (table|wide|markdown|json|yaml|template), wide is a table with more columns. (default "table") + --port string the port to be changed. + --template string output template for template output-format, go template format. + For property names inspect the output of -o json or -o yaml for reference. + Example for machines: + + metalctl machine list -o template --template "{{ .id }}:{{ .size.id }}" + + + --yes-i-really-mean-it skips security prompts (which can be dangerous to set blindly because actions can lead to data loss or additional costs) +``` + +## SEE ALSO + +* [metalctl switch port](metalctl_switch_port.md) - sets the given switch port state up or down + diff --git a/docs/src/external/metalctl/docs/metalctl_switch_port_down.md b/docs/src/external/metalctl/docs/metalctl_switch_port_down.md new file mode 100644 index 0000000000..b90fa7571a --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_switch_port_down.md @@ -0,0 +1,51 @@ +# metalctl switch port down + +sets the given switch port state down + +## Synopsis + +sets the port status to DOWN so the connected machine will not be able to connect to the switch. + +``` +metalctl switch port down [flags] +``` + +## Options + +``` + -h, --help help for down +``` + +## Options inherited from parent commands + +``` + --api-token string api token to authenticate. Can be specified with METALCTL_API_TOKEN environment variable. + --api-url string api server address. Can be specified with METALCTL_API_URL environment variable. + -c, --config string alternative config file path, (default is ~/.metalctl/config.yaml). + Example config.yaml: + + --- + apitoken: "alongtoken" + ... + + + --debug debug output + --force-color force colored output even without tty + --kubeconfig string Path to the kube-config to use for authentication and authorization. Is updated by login. Uses default path if not specified. + --no-headers do not print headers of table output format (default print headers) + -o, --output-format string output format (table|wide|markdown|json|yaml|template), wide is a table with more columns. (default "table") + --port string the port to be changed. + --template string output template for template output-format, go template format. + For property names inspect the output of -o json or -o yaml for reference. + Example for machines: + + metalctl machine list -o template --template "{{ .id }}:{{ .size.id }}" + + + --yes-i-really-mean-it skips security prompts (which can be dangerous to set blindly because actions can lead to data loss or additional costs) +``` + +## SEE ALSO + +* [metalctl switch port](metalctl_switch_port.md) - sets the given switch port state up or down + diff --git a/docs/src/external/metalctl/docs/metalctl_switch_port_up.md b/docs/src/external/metalctl/docs/metalctl_switch_port_up.md new file mode 100644 index 0000000000..1cd3aa0fde --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_switch_port_up.md @@ -0,0 +1,51 @@ +# metalctl switch port up + +sets the given switch port state up + +## Synopsis + +sets the port status to UP so the connected machine will be able to connect to the switch. + +``` +metalctl switch port up [flags] +``` + +## Options + +``` + -h, --help help for up +``` + +## Options inherited from parent commands + +``` + --api-token string api token to authenticate. Can be specified with METALCTL_API_TOKEN environment variable. + --api-url string api server address. Can be specified with METALCTL_API_URL environment variable. + -c, --config string alternative config file path, (default is ~/.metalctl/config.yaml). + Example config.yaml: + + --- + apitoken: "alongtoken" + ... + + + --debug debug output + --force-color force colored output even without tty + --kubeconfig string Path to the kube-config to use for authentication and authorization. Is updated by login. Uses default path if not specified. + --no-headers do not print headers of table output format (default print headers) + -o, --output-format string output format (table|wide|markdown|json|yaml|template), wide is a table with more columns. (default "table") + --port string the port to be changed. + --template string output template for template output-format, go template format. + For property names inspect the output of -o json or -o yaml for reference. + Example for machines: + + metalctl machine list -o template --template "{{ .id }}:{{ .size.id }}" + + + --yes-i-really-mean-it skips security prompts (which can be dangerous to set blindly because actions can lead to data loss or additional costs) +``` + +## SEE ALSO + +* [metalctl switch port](metalctl_switch_port.md) - sets the given switch port state up or down + diff --git a/docs/src/external/metalctl/docs/metalctl_update.md b/docs/src/external/metalctl/docs/metalctl_update.md index f0f4a3ce8e..31c98eeb83 100644 --- a/docs/src/external/metalctl/docs/metalctl_update.md +++ b/docs/src/external/metalctl/docs/metalctl_update.md @@ -5,8 +5,7 @@ update the program ## Options ``` - -h, --help help for update - -v, --version string the version to update to, by default updates to the supported version, use "latest" to update to latest version + -h, --help help for update ``` ## Options inherited from parent commands diff --git a/docs/src/external/metalctl/docs/metalctl_update_do.md b/docs/src/external/metalctl/docs/metalctl_update_do.md index c82fde3a3d..a52ab8a0da 100644 --- a/docs/src/external/metalctl/docs/metalctl_update_do.md +++ b/docs/src/external/metalctl/docs/metalctl_update_do.md @@ -9,7 +9,8 @@ metalctl update do [flags] ## Options ``` - -h, --help help for do + -h, --help help for do + -v, --version string the version to update to, by default updates to the supported version, use "latest" to update to latest version ``` ## Options inherited from parent commands diff --git a/docs/src/external/mini-lab/README.md b/docs/src/external/mini-lab/README.md index abbbe1542c..80163c1227 100644 --- a/docs/src/external/mini-lab/README.md +++ b/docs/src/external/mini-lab/README.md @@ -23,7 +23,7 @@ The mini-lab is a small, virtual setup to locally run the metal-stack. It deploy - kvm as hypervisor for the VMs (you can check through the `kvm-ok` command) - [docker](https://www.docker.com/) >= 20.10.13 (for using kind and our deployment base image) - [kind](https://github.com/kubernetes-sigs/kind/releases) == v0.20.0 (for hosting the metal control plane) -- [containerlab](https://containerlab.dev/install/) >= v0.47.1 +- [containerlab](https://containerlab.srlinux.dev/install/) >= v0.47.1 - the lab creates a docker network on your host machine (`172.17.0.1`), this hopefully does not overlap with other networks you have - (recommended) haveged to have enough random entropy (only needed if the PXE process does not work)