From dc261b70b13a413f6d2628c58bc72bc1627cc34a Mon Sep 17 00:00:00 2001 From: "metal-robot[bot]" <68018895+metal-robot[bot]@users.noreply.github.com> Date: Tue, 2 May 2023 14:37:17 +0200 Subject: [PATCH] Bump releases to version v0.13.1 (#130) * Bump releases to version v0.13.1 * Auto generate --------- Co-authored-by: metal-stack Co-authored-by: Gerrit91 --- Makefile | 2 +- docs/src/external/metalctl/docs/metalctl.md | 1 + .../external/metalctl/docs/metalctl_audit.md | 47 +++++++++++++ .../metalctl/docs/metalctl_audit_describe.md | 51 ++++++++++++++ .../metalctl/docs/metalctl_audit_list.md | 68 +++++++++++++++++++ 5 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 docs/src/external/metalctl/docs/metalctl_audit.md create mode 100644 docs/src/external/metalctl/docs/metalctl_audit_describe.md create mode 100644 docs/src/external/metalctl/docs/metalctl_audit_list.md diff --git a/Makefile b/Makefile index efef52e1a1..8002ae913a 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ .DEFAULT_GOAL := build -RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.13.0") +RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.13.1") ifeq ($(CI),true) DOCKER_TTY_ARG= diff --git a/docs/src/external/metalctl/docs/metalctl.md b/docs/src/external/metalctl/docs/metalctl.md index 77abb17ff6..2834ff35be 100644 --- a/docs/src/external/metalctl/docs/metalctl.md +++ b/docs/src/external/metalctl/docs/metalctl.md @@ -33,6 +33,7 @@ a cli to manage entities in the metal-stack api ## SEE ALSO +* [metalctl audit](metalctl_audit.md) - manage audit trace entities * [metalctl completion](metalctl_completion.md) - Generate the autocompletion script for the specified shell * [metalctl context](metalctl_context.md) - manage metalctl context * [metalctl filesystemlayout](metalctl_filesystemlayout.md) - manage filesystemlayout entities diff --git a/docs/src/external/metalctl/docs/metalctl_audit.md b/docs/src/external/metalctl/docs/metalctl_audit.md new file mode 100644 index 0000000000..96baf95d99 --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_audit.md @@ -0,0 +1,47 @@ +# metalctl audit + +manage audit trace entities + +## Synopsis + +show audit traces of the api. feature must be enabled on server-side. + +## Options + +``` + -h, --help help for audit +``` + +## 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](metalctl.md) - a cli to manage entities in the metal-stack api +- [metalctl audit list](metalctl_audit_list.md) - list all audit traces +- [metalctl audit describe](metalctl_audit_describe.md) - describe an audit trace diff --git a/docs/src/external/metalctl/docs/metalctl_audit_describe.md b/docs/src/external/metalctl/docs/metalctl_audit_describe.md new file mode 100644 index 0000000000..f3c3a64afd --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_audit_describe.md @@ -0,0 +1,51 @@ +# metalctl audit describe + +describe an audit trace + +``` +metalctl audit describe [flags] +``` + +## Options + +``` + -h, --help help for list +``` + +## 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](metalctl.md) - a cli to manage entities in the metal-stack api +- [metalctl audit list](metalctl_audit_list.md) - list all audit traces +- [metalctl audit describe](metalctl_audit_describe.md) - describe an audit trace diff --git a/docs/src/external/metalctl/docs/metalctl_audit_list.md b/docs/src/external/metalctl/docs/metalctl_audit_list.md new file mode 100644 index 0000000000..1e23d1d56d --- /dev/null +++ b/docs/src/external/metalctl/docs/metalctl_audit_list.md @@ -0,0 +1,68 @@ +# metalctl audit list + +list all audit traces + +``` +metalctl audit list [flags] +``` + +## Options + +```` + --component string component of the audit trace. + --detail string detail of the audit trace. An HTTP method, unary or stream + --error string error of the audit trace. + --forwarded-for string forwarded for of the audit trace. + --from string start of range of the audit traces. e.g. 1h, 10m, 2006-01-02 15:04:05 + -h, --help help for list + --limit int limit the number of audit traces. (default 100) + --path string api path of the audit trace. + --phase string phase of the audit trace. One of [request, response, single, error, opened, closed] + -q, --query string filters audit trace body payloads for the given text. + --remote-addr string remote address of the audit trace. + --request-id string request id of the audit trace. + --sort-by strings sort by (comma separated) column(s), sort direction can be changed by appending :asc or :desc behind the column identifier. possible values: path|tenant|timestamp|user + --status-code int32 HTTP status code of the audit trace. + --tenant string tenant of the audit trace. + --to string end of range of the audit traces. e.g. 1h, 10m, 2006-01-02 15:04:05 + --type string type of the audit trace. One of [http, grpc, event]. + --user string user of the audit trace.``` +```` + +## 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](metalctl.md) - a cli to manage entities in the metal-stack api +- [metalctl audit list](metalctl_audit_list.md) - list all audit traces +- [metalctl audit describe](metalctl_audit_describe.md) - describe an audit trace