feat: rename osctl to talosctl

This is a rename of the osctl binary. We decided that talosctl is a
better name for the Talos CLI. This does not break any APIs, but does
make older documentation only accurate for previous versions of Talos.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
This commit is contained in:
Andrew Rynhard 2020-03-20 17:38:48 -07:00
parent 69fa63a7b2
commit 5dbc26c7a3
162 changed files with 3427 additions and 411 deletions

View File

@ -29,7 +29,7 @@ policies:
- machined
- networkd
- ntpd
- osctl
- talosctl
- osd
- rootfs
- tools

View File

@ -49,11 +49,11 @@ steps:
- name: tmp
path: /tmp
- name: osctl-linux
- name: talosctl-linux
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-linux
- make talosctl-linux
volumes:
- name: dockersock
path: /var/run
@ -68,11 +68,11 @@ steps:
depends_on:
- setup-ci
- name: osctl-darwin
- name: talosctl-darwin
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-darwin
- make talosctl-darwin
volumes:
- name: dockersock
path: /var/run
@ -104,7 +104,7 @@ steps:
- name: tmp
path: /tmp
depends_on:
- osctl-linux
- talosctl-linux
- name: kernel
pull: always
@ -469,7 +469,7 @@ steps:
path: /tmp
depends_on:
- talos
- osctl-linux
- talosctl-linux
- name: e2e-firecracker
pull: always
@ -492,7 +492,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -517,7 +517,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -669,11 +669,11 @@ steps:
- name: tmp
path: /tmp
- name: osctl-linux
- name: talosctl-linux
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-linux
- make talosctl-linux
volumes:
- name: dockersock
path: /var/run
@ -688,11 +688,11 @@ steps:
depends_on:
- setup-ci
- name: osctl-darwin
- name: talosctl-darwin
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-darwin
- make talosctl-darwin
volumes:
- name: dockersock
path: /var/run
@ -724,7 +724,7 @@ steps:
- name: tmp
path: /tmp
depends_on:
- osctl-linux
- talosctl-linux
- name: kernel
pull: always
@ -1089,7 +1089,7 @@ steps:
path: /tmp
depends_on:
- talos
- osctl-linux
- talosctl-linux
- name: e2e-firecracker
pull: always
@ -1112,7 +1112,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -1137,7 +1137,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -1381,11 +1381,11 @@ steps:
- name: tmp
path: /tmp
- name: osctl-linux
- name: talosctl-linux
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-linux
- make talosctl-linux
volumes:
- name: dockersock
path: /var/run
@ -1400,11 +1400,11 @@ steps:
depends_on:
- setup-ci
- name: osctl-darwin
- name: talosctl-darwin
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-darwin
- make talosctl-darwin
volumes:
- name: dockersock
path: /var/run
@ -1436,7 +1436,7 @@ steps:
- name: tmp
path: /tmp
depends_on:
- osctl-linux
- talosctl-linux
- name: kernel
pull: always
@ -1801,7 +1801,7 @@ steps:
path: /tmp
depends_on:
- talos
- osctl-linux
- talosctl-linux
- name: e2e-firecracker
pull: always
@ -1824,7 +1824,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -1849,7 +1849,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -2123,11 +2123,11 @@ steps:
- name: tmp
path: /tmp
- name: osctl-linux
- name: talosctl-linux
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-linux
- make talosctl-linux
volumes:
- name: dockersock
path: /var/run
@ -2142,11 +2142,11 @@ steps:
depends_on:
- setup-ci
- name: osctl-darwin
- name: talosctl-darwin
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-darwin
- make talosctl-darwin
volumes:
- name: dockersock
path: /var/run
@ -2178,7 +2178,7 @@ steps:
- name: tmp
path: /tmp
depends_on:
- osctl-linux
- talosctl-linux
- name: kernel
pull: always
@ -2543,7 +2543,7 @@ steps:
path: /tmp
depends_on:
- talos
- osctl-linux
- talosctl-linux
- name: e2e-firecracker
pull: always
@ -2566,7 +2566,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -2591,7 +2591,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -2865,11 +2865,11 @@ steps:
- name: tmp
path: /tmp
- name: osctl-linux
- name: talosctl-linux
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-linux
- make talosctl-linux
volumes:
- name: dockersock
path: /var/run
@ -2884,11 +2884,11 @@ steps:
depends_on:
- setup-ci
- name: osctl-darwin
- name: talosctl-darwin
pull: always
image: autonomy/build-container:latest
commands:
- make osctl-darwin
- make talosctl-darwin
volumes:
- name: dockersock
path: /var/run
@ -2920,7 +2920,7 @@ steps:
- name: tmp
path: /tmp
depends_on:
- osctl-linux
- talosctl-linux
- name: kernel
pull: always
@ -3285,7 +3285,7 @@ steps:
path: /tmp
depends_on:
- talos
- osctl-linux
- talosctl-linux
- name: e2e-firecracker
pull: always
@ -3308,7 +3308,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -3333,7 +3333,7 @@ steps:
path: /tmp
depends_on:
- initramfs
- osctl-linux
- talosctl-linux
- kernel
- push-local
@ -3456,8 +3456,8 @@ steps:
- _out/gcp.tar.gz
- _out/initramfs.xz
- _out/installer.tar
- _out/osctl-darwin-amd64
- _out/osctl-linux-amd64
- _out/talosctl-darwin-amd64
- _out/talosctl-linux-amd64
- _out/vmware.ova
- _out/vmlinux
- _out/vmlinuz
@ -3572,6 +3572,6 @@ depends_on:
---
kind: signature
hmac: 0ee401dcb1d7b3fcdf17392c436730a6031e265543436865a68b95c7560e63df
hmac: de88d1e74755b71883afb67e12dea17205b75e9ec462837f035257292ffbe805
...

View File

@ -124,7 +124,7 @@ issues:
- ^ST1000 # ST1000: package comment should be of the form "Package services ..." (stylecheck)
exclude-rules:
- path: cmd/osctl/cmd
- path: cmd/talosctl/cmd
linters:
- dupl
- path: internal/app/machined/internal/phase

View File

@ -55,11 +55,11 @@ make ci
In the `Makefile` there are a variety of targets, the most common are:
* `kernel` creates the `vmlinuz` Linux kernel executable.
* `initamfs` creates the `initramfs.xz` initial RAMdisk filesystem.
* `image-vanilla` creates the `image.raw` file that can be used as a image volume for VMs.
* `osctl-linux-amd64` and `osctl-darwin-amd64` make the `osctl` CLI tool for Linux & OSX respectively.
* `rootfs` creates an archive of the root filesystem preloaded with all the components needed to launch Talos & Kubernetes.
- `kernel` creates the `vmlinuz` Linux kernel executable.
- `initamfs` creates the `initramfs.xz` initial RAMdisk filesystem.
- `image-vanilla` creates the `image.raw` file that can be used as a image volume for VMs.
- `talosctl-linux-amd64` and `talosctl-darwin-amd64` make the `talosctl` CLI tool for Linux & OSX respectively.
- `rootfs` creates an archive of the root filesystem preloaded with all the components needed to launch Talos & Kubernetes.
# Buildkit

View File

@ -215,33 +215,33 @@ RUN printf "FROM scratch\nCOPY ./routerd /routerd\nENTRYPOINT [\"/routerd\"]" >
RUN --security=insecure img build --tag ${USERNAME}/routerd:${TAG} --output type=docker,dest=/routerd.tar --no-console .
# The osctl targets build the osctl binaries.
# The talosctl targets build the talosctl binaries.
FROM base AS osctl-linux-build
FROM base AS talosctl-linux-build
ARG SHA
ARG TAG
ARG ARTIFACTS
ARG VERSION_PKG="github.com/talos-systems/talos/pkg/version"
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/osctl/pkg/mgmt/helpers"
WORKDIR /src/cmd/osctl
RUN --mount=type=cache,target=/.cache/go-build GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X ${VERSION_PKG}.Name=Client -X ${VERSION_PKG}.SHA=${SHA} -X ${VERSION_PKG}.Tag=${TAG} -X ${MGMT_HELPERS_PKG}.ArtifactsPath=${ARTIFACTS}" -o /osctl-linux-amd64
RUN chmod +x /osctl-linux-amd64
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/talosctl/pkg/mgmt/helpers"
WORKDIR /src/cmd/talosctl
RUN --mount=type=cache,target=/.cache/go-build GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X ${VERSION_PKG}.Name=Client -X ${VERSION_PKG}.SHA=${SHA} -X ${VERSION_PKG}.Tag=${TAG} -X ${MGMT_HELPERS_PKG}.ArtifactsPath=${ARTIFACTS}" -o /talosctl-linux-amd64
RUN chmod +x /talosctl-linux-amd64
FROM scratch AS osctl-linux
COPY --from=osctl-linux-build /osctl-linux-amd64 /osctl-linux-amd64
FROM scratch AS talosctl-linux
COPY --from=talosctl-linux-build /talosctl-linux-amd64 /talosctl-linux-amd64
FROM base AS osctl-darwin-build
FROM base AS talosctl-darwin-build
ARG SHA
ARG TAG
ARG ARTIFACTS
ARG VERSION_PKG="github.com/talos-systems/talos/pkg/version"
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/osctl/pkg/mgmt/helpers"
WORKDIR /src/cmd/osctl
RUN --mount=type=cache,target=/.cache/go-build GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X ${VERSION_PKG}.Name=Client -X ${VERSION_PKG}.SHA=${SHA} -X ${VERSION_PKG}.Tag=${TAG} -X ${MGMT_HELPERS_PKG}.ArtifactsPath=${ARTIFACTS}" -o /osctl-darwin-amd64
RUN chmod +x /osctl-darwin-amd64
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/talosctl/pkg/mgmt/helpers"
WORKDIR /src/cmd/talosctl
RUN --mount=type=cache,target=/.cache/go-build GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X ${VERSION_PKG}.Name=Client -X ${VERSION_PKG}.SHA=${SHA} -X ${VERSION_PKG}.Tag=${TAG} -X ${MGMT_HELPERS_PKG}.ArtifactsPath=${ARTIFACTS}" -o /talosctl-darwin-amd64
RUN chmod +x /talosctl-darwin-amd64
FROM scratch AS osctl-darwin
COPY --from=osctl-darwin-build /osctl-darwin-amd64 /osctl-darwin-amd64
FROM scratch AS talosctl-darwin
COPY --from=talosctl-darwin-build /talosctl-darwin-amd64 /talosctl-darwin-amd64
# The kernel target is the linux kernel.
@ -343,7 +343,7 @@ COPY --from=kernel /vmlinuz /usr/install/vmlinuz
COPY --from=rootfs /usr/lib/syslinux/ /usr/lib/syslinux
COPY --from=initramfs /initramfs.xz /usr/install/initramfs.xz
COPY --from=installer-build /installer /bin/installer
RUN ln -s /bin/installer /bin/osctl
RUN ln -s /bin/installer /bin/talosctl
ARG TAG
ENV VERSION ${TAG}
LABEL "alpha.talos.dev/version"="${VERSION}"
@ -421,7 +421,7 @@ FROM base AS integration-test-provision-linux-build
ARG SHA
ARG TAG
ARG VERSION_PKG="github.com/talos-systems/talos/pkg/version"
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/osctl/pkg/mgmt/helpers"
ARG MGMT_HELPERS_PKG="github.com/talos-systems/talos/cmd/talosctl/pkg/mgmt/helpers"
ARG ARTIFACTS
RUN --mount=type=cache,target=/.cache/go-build GOOS=linux GOARCH=amd64 go test -c \
-ldflags "-s -w -X ${VERSION_PKG}.Name=Client -X ${VERSION_PKG}.SHA=${SHA} -X ${VERSION_PKG}.Tag=${TAG} -X ${MGMT_HELPERS_PKG}.ArtifactsPath=${ARTIFACTS}" \
@ -460,10 +460,10 @@ RUN markdownlint --rules /node_modules/sentences-per-line/index.js .
FROM base AS docs-build
RUN go generate ./pkg/config/types/v1alpha1
COPY --from=osctl-linux /osctl-linux-amd64 /bin/osctl
RUN mkdir -p /docs/osctl \
&& env HOME=/home/user TAG=latest /bin/osctl docs /docs/osctl
COPY --from=talosctl-linux /talosctl-linux-amd64 /bin/talosctl
RUN mkdir -p /docs/talosctl \
&& env HOME=/home/user TAG=latest /bin/talosctl docs /docs/talosctl
FROM scratch AS docs
COPY --from=docs-build /tmp/v1alpha1.md /docs/website/content/v0.3/en/configuration/v1alpha1.md
COPY --from=docs-build /docs/osctl/* /docs/osctl/
COPY --from=docs-build /tmp/v1alpha1.md /docs/website/content/v0.4/en/configuration/v1alpha1.md
COPY --from=docs-build /docs/talosctl/* /docs/talosctl/

View File

@ -10,7 +10,7 @@ ARTIFACTS := _out
TOOLS ?= autonomy/tools:v0.1.0-3-g84e76d6
GO_VERSION ?= 1.14
OPERATING_SYSTEM := $(shell uname -s | tr "[:upper:]" "[:lower:]")
OSCTL_DEFAULT_TARGET := osctl-$(OPERATING_SYSTEM)
OSCTL_DEFAULT_TARGET := talosctl-$(OPERATING_SYSTEM)
INTEGRATION_TEST_DEFAULT_TARGET := integration-test-$(OPERATING_SYSTEM)
INTEGRATION_TEST_PROVISION_DEFAULT_TARGET := integration-test-provision-$(OPERATING_SYSTEM)
KUBECTL_URL ?= https://storage.googleapis.com/kubernetes-release/release/v1.17.1/bin/$(OPERATING_SYSTEM)/amd64/kubectl
@ -37,7 +37,7 @@ COMMON_ARGS += --build-arg=USERNAME=$(USERNAME)
COMMON_ARGS += --build-arg=http_proxy=$(http_proxy)
COMMON_ARGS += --build-arg=https_proxy=$(https_proxy)
all: initramfs kernel installer osctl talos
all: initramfs kernel installer talosctl talos
# Help Menu
@ -106,8 +106,8 @@ generate: ## Generates source code from protobuf definitions.
@$(MAKE) local-$@ DEST=./
.PHONY: docs
docs: ## Generates the documentation for machine config, and osctl.
@rm -rf docs/osctl/*
docs: ## Generates the documentation for machine config, and talosctl.
@rm -rf docs/talosctl/*
@$(MAKE) local-$@ DEST=./
# Local Artifacts
@ -132,10 +132,10 @@ talos: ## Builds the Talos container image and outputs it to the artifact direct
@mv $(ARTIFACTS)/$@.tar $(ARTIFACTS)/container.tar
@docker load < $(ARTIFACTS)/container.tar
osctl-%:
talosctl-%:
@$(MAKE) local-$@ DEST=$(ARTIFACTS)
osctl: $(OSCTL_DEFAULT_TARGET) ## Builds the osctl binary for the local machine.
talosctl: $(OSCTL_DEFAULT_TARGET) ## Builds the talosctl binary for the local machine.
image-%: ## Builds the specified image. Valid options are aws, azure, digital-ocean, gcp, and vmware (e.g. image-aws)
@docker run --rm -v /dev:/dev -v $(PWD)/$(ARTIFACTS):/out --privileged autonomy/installer:$(TAG) image --platform $*

View File

@ -19,7 +19,7 @@ var completionCmd = &cobra.Command{
Short: "Output shell completion code for the specified shell (bash or zsh)",
Long: `Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive
completion of osctl commands. This can be done by sourcing it from
completion of talosctl commands. This can be done by sourcing it from
the .bash_profile.
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2`,
@ -28,26 +28,26 @@ Note for zsh users: [1] zsh completions are only supported in versions of zsh >=
brew install bash-completion
## or, if running Bash 4.1+
brew install bash-completion@2
## If osctl is installed via homebrew, this should start working immediately.
## If talosctl is installed via homebrew, this should start working immediately.
## If you've installed via other means, you may need add the completion to your completion directory
osctl completion bash > $(brew --prefix)/etc/bash_completion.d/osctl
talosctl completion bash > $(brew --prefix)/etc/bash_completion.d/talosctl
# Installing bash completion on Linux
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
## via your distribution's package manager.
## Load the osctl completion code for bash into the current shell
source <(osctl completion bash)
## Load the talosctl completion code for bash into the current shell
source <(talosctl completion bash)
## Write bash completion code to a file and source if from .bash_profile
osctl completion bash > ~/.talos/completion.bash.inc
talosctl completion bash > ~/.talos/completion.bash.inc
printf "
# osctl shell completion
# talosctl shell completion
source '$HOME/.talos/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the osctl completion code for zsh[1] into the current shell
source <(osctl completion zsh)
# Set the osctl completion code for zsh[1] to autoload on startup
osctl completion zsh > "${fpath[1]}/_osctl"`,
# Load the talosctl completion code for zsh[1] into the current shell
source <(talosctl completion zsh)
# Set the talosctl completion code for zsh[1] to autoload on startup
talosctl completion zsh > "${fpath[1]}/_osctl"`,
ValidArgs: []string{"bash", "zsh"},
Args: cobra.ExactValidArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {

View File

@ -5,7 +5,7 @@
package mgmt
import (
"github.com/talos-systems/talos/cmd/osctl/cmd/mgmt/cluster"
"github.com/talos-systems/talos/cmd/talosctl/cmd/mgmt/cluster"
)
func init() {

View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
clientconfig "github.com/talos-systems/talos/cmd/osctl/pkg/client/config"
clientconfig "github.com/talos-systems/talos/cmd/talosctl/pkg/client/config"
)
// Cmd represents the cluster command

View File

@ -16,8 +16,8 @@ import (
"github.com/spf13/cobra"
clientconfig "github.com/talos-systems/talos/cmd/osctl/pkg/client/config"
"github.com/talos-systems/talos/cmd/osctl/pkg/mgmt/helpers"
clientconfig "github.com/talos-systems/talos/cmd/talosctl/pkg/client/config"
"github.com/talos-systems/talos/cmd/talosctl/pkg/mgmt/helpers"
"github.com/talos-systems/talos/internal/pkg/provision"
"github.com/talos-systems/talos/internal/pkg/provision/access"
"github.com/talos-systems/talos/internal/pkg/provision/check"
@ -255,7 +255,7 @@ func create(ctx context.Context) (err error) {
return err
}
// Create and save the osctl configuration file.
// Create and save the talosctl configuration file.
if err = saveConfig(cluster, configBundle.TalosConfig()); err != nil {
return err
}

View File

@ -15,7 +15,7 @@ import (
"github.com/spf13/cobra"
"gopkg.in/yaml.v2"
"github.com/talos-systems/talos/cmd/osctl/pkg/mgmt/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/mgmt/helpers"
"github.com/talos-systems/talos/pkg/config"
"github.com/talos-systems/talos/pkg/config/machine"
"github.com/talos-systems/talos/pkg/config/types/v1alpha1/generate"

View File

@ -11,14 +11,14 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/cmd/mgmt"
"github.com/talos-systems/talos/cmd/osctl/cmd/talos"
"github.com/talos-systems/talos/cmd/osctl/pkg/client/config"
"github.com/talos-systems/talos/cmd/talosctl/cmd/mgmt"
"github.com/talos-systems/talos/cmd/talosctl/cmd/talos"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client/config"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "osctl",
Use: "talosctl",
Short: "A CLI for out-of-band management of Kubernetes nodes created by Talos",
Long: ``,
SilenceErrors: true,

View File

@ -11,7 +11,7 @@ import (
"github.com/spf13/cobra"
clientconfig "github.com/talos-systems/talos/cmd/osctl/pkg/client/config"
clientconfig "github.com/talos-systems/talos/cmd/talosctl/pkg/client/config"
"github.com/talos-systems/talos/pkg/cli"
)
@ -156,7 +156,7 @@ var configGenerateCmd = &cobra.Command{
Long: ``,
Hidden: true,
RunE: func(cmd *cobra.Command, args []string) error {
return fmt.Errorf("'osctl config generate' was renamed to 'osctl gen config'")
return fmt.Errorf("'talosctl config generate' was renamed to 'talosctl gen config'")
},
}

View File

@ -19,8 +19,8 @@ import (
"github.com/talos-systems/talos/api/common"
osapi "github.com/talos-systems/talos/api/os"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/constants"
)

View File

@ -14,8 +14,8 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
)
// cpCmd represents the cp command
@ -28,7 +28,7 @@ streams it back to the client.
If '-' is given for <local-path>, archive is written to stdout.
Otherwise archive is extracted to <local-path> which should be an empty directory or
osctl creates a directory if <local-path> doesn't exist. Command doesn't preserve
talosctl creates a directory if <local-path> doesn't exist. Command doesn't preserve
ownership and access mode for the files in extract mode, while streamed .tar archive
captures ownership and permission bits.`,
Args: cobra.ExactArgs(2),

View File

@ -14,8 +14,8 @@ import (
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
)
var dmesgTail bool

View File

@ -15,8 +15,8 @@ import (
"google.golang.org/grpc/peer"
networkapi "github.com/talos-systems/talos/api/network"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -13,8 +13,8 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
)
var force bool

View File

@ -18,8 +18,8 @@ import (
"google.golang.org/grpc/status"
machineapi "github.com/talos-systems/talos/api/machine"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
)
const sixMonths = 6 * time.Hour * 24 * 30

View File

@ -19,8 +19,8 @@ import (
"github.com/talos-systems/talos/api/common"
"github.com/talos-systems/talos/api/machine"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/constants"
)

View File

@ -15,8 +15,8 @@ import (
"google.golang.org/grpc/peer"
osapi "github.com/talos-systems/talos/api/os"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -16,8 +16,8 @@ import (
"google.golang.org/grpc/peer"
machineapi "github.com/talos-systems/talos/api/machine"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -22,8 +22,8 @@ import (
"google.golang.org/grpc/peer"
osapi "github.com/talos-systems/talos/api/os"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -13,8 +13,8 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
)
// readCmd represents the read command

View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
)
// rebootCmd represents the reboot command

View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
)
var (

View File

@ -12,7 +12,7 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/api/common"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/pkg/constants"
)

View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/constants"
"github.com/talos-systems/talos/pkg/grpc/tls"

View File

@ -15,8 +15,8 @@ import (
"google.golang.org/grpc/peer"
networkapi "github.com/talos-systems/talos/api/network"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -17,8 +17,8 @@ import (
"google.golang.org/grpc/peer"
machineapi "github.com/talos-systems/talos/api/machine"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
)
// shutdownCmd represents the shutdown command

View File

@ -19,8 +19,8 @@ import (
"github.com/talos-systems/talos/api/common"
osapi "github.com/talos-systems/talos/api/os"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/constants"
)

View File

@ -17,8 +17,8 @@ import (
"google.golang.org/grpc/peer"
timeapi "github.com/talos-systems/talos/api/time"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -15,8 +15,8 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/peer"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
)

View File

@ -12,8 +12,8 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/peer"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/osctl/pkg/talos/helpers"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/talos/helpers"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/version"
)

View File

@ -7,7 +7,7 @@ package main
import (
"os"
"github.com/talos-systems/talos/cmd/osctl/cmd"
"github.com/talos-systems/talos/cmd/talosctl/cmd"
"github.com/talos-systems/talos/pkg/cli"
"github.com/talos-systems/talos/pkg/startup"
)

View File

@ -26,7 +26,7 @@ import (
networkapi "github.com/talos-systems/talos/api/network"
osapi "github.com/talos-systems/talos/api/os"
timeapi "github.com/talos-systems/talos/api/time"
"github.com/talos-systems/talos/cmd/osctl/pkg/client/config"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client/config"
"github.com/talos-systems/talos/pkg/net"
)

View File

@ -11,7 +11,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/talos-systems/talos/api/common"
"github.com/talos-systems/talos/cmd/osctl/pkg/client"
"github.com/talos-systems/talos/cmd/talosctl/pkg/client"
)
func TestFilterMessages(t *testing.T) {

View File

@ -1,48 +0,0 @@
<!-- markdownlint-disable -->
## osctl
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Synopsis
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Options
```
--context string Context to be used in command
-e, --endpoints strings override default endpoints in Talos configuration
-h, --help help for osctl
-n, --nodes strings target the specified nodes
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
```
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters
* [osctl completion](osctl_completion.md) - Output shell completion code for the specified shell (bash or zsh)
* [osctl config](osctl_config.md) - Manage the client configuration
* [osctl containers](osctl_containers.md) - List containers
* [osctl copy](osctl_copy.md) - Copy data out from the node
* [osctl dmesg](osctl_dmesg.md) - Retrieve kernel logs
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [osctl interfaces](osctl_interfaces.md) - List network interfaces
* [osctl kubeconfig](osctl_kubeconfig.md) - Download the admin kubeconfig from the node
* [osctl list](osctl_list.md) - Retrieve a directory listing
* [osctl logs](osctl_logs.md) - Retrieve logs for a process or container
* [osctl memory](osctl_memory.md) - Show memory usage
* [osctl mounts](osctl_mounts.md) - List mounts
* [osctl processes](osctl_processes.md) - List running processes
* [osctl read](osctl_read.md) - Read a file on the machine
* [osctl reboot](osctl_reboot.md) - Reboot a node
* [osctl reset](osctl_reset.md) - Reset a node
* [osctl restart](osctl_restart.md) - Restart a process
* [osctl routes](osctl_routes.md) - List network routes
* [osctl service](osctl_service.md) - Retrieve the state of a service (or all services), control service state
* [osctl shutdown](osctl_shutdown.md) - Shutdown a node
* [osctl stats](osctl_stats.md) - Get processes stats
* [osctl time](osctl_time.md) - Gets current server time
* [osctl upgrade](osctl_upgrade.md) - Upgrade Talos on the target node
* [osctl validate](osctl_validate.md) - Validate config
* [osctl version](osctl_version.md) - Prints the version

View File

@ -1,34 +0,0 @@
<!-- markdownlint-disable -->
## osctl gen
Generate CAs, certificates, and private keys
### Synopsis
Generate CAs, certificates, and private keys
### Options
```
-h, --help help for gen
```
### Options inherited from parent commands
```
--context string Context to be used in command
-e, --endpoints strings override default endpoints in Talos configuration
-n, --nodes strings target the specified nodes
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl gen ca](osctl_gen_ca.md) - Generates a self-signed X.509 certificate authority
* [osctl gen config](osctl_gen_config.md) - Generates a set of configuration files for Talos cluster
* [osctl gen crt](osctl_gen_crt.md) - Generates an X.509 Ed25519 certificate
* [osctl gen csr](osctl_gen_csr.md) - Generates a CSR using an Ed25519 private key
* [osctl gen key](osctl_gen_key.md) - Generates an Ed25519 private key
* [osctl gen keypair](osctl_gen_keypair.md) - Generates an X.509 Ed25519 key pair

48
docs/talosctl/talosctl.md Normal file
View File

@ -0,0 +1,48 @@
<!-- markdownlint-disable -->
## talosctl
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Synopsis
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Options
```
--context string Context to be used in command
-e, --endpoints strings override default endpoints in Talos configuration
-h, --help help for talosctl
-n, --nodes strings target the specified nodes
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
```
### SEE ALSO
* [talosctl cluster](talosctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters
* [talosctl completion](talosctl_completion.md) - Output shell completion code for the specified shell (bash or zsh)
* [talosctl config](talosctl_config.md) - Manage the client configuration
* [talosctl containers](talosctl_containers.md) - List containers
* [talosctl copy](talosctl_copy.md) - Copy data out from the node
* [talosctl dmesg](talosctl_dmesg.md) - Retrieve kernel logs
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl interfaces](talosctl_interfaces.md) - List network interfaces
* [talosctl kubeconfig](talosctl_kubeconfig.md) - Download the admin kubeconfig from the node
* [talosctl list](talosctl_list.md) - Retrieve a directory listing
* [talosctl logs](talosctl_logs.md) - Retrieve logs for a process or container
* [talosctl memory](talosctl_memory.md) - Show memory usage
* [talosctl mounts](talosctl_mounts.md) - List mounts
* [talosctl processes](talosctl_processes.md) - List running processes
* [talosctl read](talosctl_read.md) - Read a file on the machine
* [talosctl reboot](talosctl_reboot.md) - Reboot a node
* [talosctl reset](talosctl_reset.md) - Reset a node
* [talosctl restart](talosctl_restart.md) - Restart a process
* [talosctl routes](talosctl_routes.md) - List network routes
* [talosctl service](talosctl_service.md) - Retrieve the state of a service (or all services), control service state
* [talosctl shutdown](talosctl_shutdown.md) - Shutdown a node
* [talosctl stats](talosctl_stats.md) - Get processes stats
* [talosctl time](talosctl_time.md) - Gets current server time
* [talosctl upgrade](talosctl_upgrade.md) - Upgrade Talos on the target node
* [talosctl validate](talosctl_validate.md) - Validate config
* [talosctl version](talosctl_version.md) - Prints the version

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl cluster
## talosctl cluster
A collection of commands for managing local docker-based or firecracker-based clusters
@ -27,8 +27,8 @@ A collection of commands for managing local docker-based or firecracker-based cl
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl cluster create](osctl_cluster_create.md) - Creates a local docker-based or firecracker-based kubernetes cluster
* [osctl cluster destroy](osctl_cluster_destroy.md) - Destroys a local docker-based or firecracker-based kubernetes cluster
* [osctl cluster show](osctl_cluster_show.md) - Shows info about a local provisioned kubernetes cluster
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl cluster create](talosctl_cluster_create.md) - Creates a local docker-based or firecracker-based kubernetes cluster
* [talosctl cluster destroy](talosctl_cluster_destroy.md) - Destroys a local docker-based or firecracker-based kubernetes cluster
* [talosctl cluster show](talosctl_cluster_show.md) - Shows info about a local provisioned kubernetes cluster

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl cluster create
## talosctl cluster create
Creates a local docker-based or firecracker-based kubernetes cluster
@ -8,7 +8,7 @@ Creates a local docker-based or firecracker-based kubernetes cluster
Creates a local docker-based or firecracker-based kubernetes cluster
```
osctl cluster create [flags]
talosctl cluster create [flags]
```
### Options
@ -55,5 +55,5 @@ osctl cluster create [flags]
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters
* [talosctl cluster](talosctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl cluster destroy
## talosctl cluster destroy
Destroys a local docker-based or firecracker-based kubernetes cluster
@ -8,7 +8,7 @@ Destroys a local docker-based or firecracker-based kubernetes cluster
Destroys a local docker-based or firecracker-based kubernetes cluster
```
osctl cluster destroy [flags]
talosctl cluster destroy [flags]
```
### Options
@ -31,5 +31,5 @@ osctl cluster destroy [flags]
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters
* [talosctl cluster](talosctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl cluster show
## talosctl cluster show
Shows info about a local provisioned kubernetes cluster
@ -8,7 +8,7 @@ Shows info about a local provisioned kubernetes cluster
Shows info about a local provisioned kubernetes cluster
```
osctl cluster show [flags]
talosctl cluster show [flags]
```
### Options
@ -31,5 +31,5 @@ osctl cluster show [flags]
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters
* [talosctl cluster](talosctl_cluster.md) - A collection of commands for managing local docker-based or firecracker-based clusters

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl completion
## talosctl completion
Output shell completion code for the specified shell (bash or zsh)
@ -7,13 +7,13 @@ Output shell completion code for the specified shell (bash or zsh)
Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive
completion of osctl commands. This can be done by sourcing it from
completion of talosctl commands. This can be done by sourcing it from
the .bash_profile.
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
```
osctl completion SHELL [flags]
talosctl completion SHELL [flags]
```
### Examples
@ -24,26 +24,26 @@ osctl completion SHELL [flags]
brew install bash-completion
## or, if running Bash 4.1+
brew install bash-completion@2
## If osctl is installed via homebrew, this should start working immediately.
## If talosctl is installed via homebrew, this should start working immediately.
## If you've installed via other means, you may need add the completion to your completion directory
osctl completion bash > $(brew --prefix)/etc/bash_completion.d/osctl
talosctl completion bash > $(brew --prefix)/etc/bash_completion.d/talosctl
# Installing bash completion on Linux
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
## via your distribution's package manager.
## Load the osctl completion code for bash into the current shell
source <(osctl completion bash)
## Load the talosctl completion code for bash into the current shell
source <(talosctl completion bash)
## Write bash completion code to a file and source if from .bash_profile
osctl completion bash > ~/.talos/completion.bash.inc
talosctl completion bash > ~/.talos/completion.bash.inc
printf "
# osctl shell completion
# talosctl shell completion
source '$HOME/.talos/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the osctl completion code for zsh[1] into the current shell
source <(osctl completion zsh)
# Set the osctl completion code for zsh[1] to autoload on startup
osctl completion zsh > "${fpath[1]}/_osctl"
# Load the talosctl completion code for zsh[1] into the current shell
source <(talosctl completion zsh)
# Set the talosctl completion code for zsh[1] to autoload on startup
talosctl completion zsh > "${fpath[1]}/_osctl"
```
### Options
@ -63,5 +63,5 @@ osctl completion zsh > "${fpath[1]}/_osctl"
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl config
## talosctl config
Manage the client configuration
@ -24,9 +24,9 @@ Manage the client configuration
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl config add](osctl_config_add.md) - Add a new context
* [osctl config context](osctl_config_context.md) - Set the current context
* [osctl config endpoint](osctl_config_endpoint.md) - Set the endpoint(s) for the current context
* [osctl config node](osctl_config_node.md) - Set the node(s) for the current context
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl config add](talosctl_config_add.md) - Add a new context
* [talosctl config context](talosctl_config_context.md) - Set the current context
* [talosctl config endpoint](talosctl_config_endpoint.md) - Set the endpoint(s) for the current context
* [talosctl config node](talosctl_config_node.md) - Set the node(s) for the current context

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl config add
## talosctl config add
Add a new context
@ -8,7 +8,7 @@ Add a new context
Add a new context
```
osctl config add <context> [flags]
talosctl config add <context> [flags]
```
### Options
@ -31,5 +31,5 @@ osctl config add <context> [flags]
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
* [talosctl config](talosctl_config.md) - Manage the client configuration

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl config context
## talosctl config context
Set the current context
@ -8,7 +8,7 @@ Set the current context
Set the current context
```
osctl config context <context> [flags]
talosctl config context <context> [flags]
```
### Options
@ -28,5 +28,5 @@ osctl config context <context> [flags]
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
* [talosctl config](talosctl_config.md) - Manage the client configuration

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl config endpoint
## talosctl config endpoint
Set the endpoint(s) for the current context
@ -8,7 +8,7 @@ Set the endpoint(s) for the current context
Set the endpoint(s) for the current context
```
osctl config endpoint <endpoint>... [flags]
talosctl config endpoint <endpoint>... [flags]
```
### Options
@ -28,5 +28,5 @@ osctl config endpoint <endpoint>... [flags]
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
* [talosctl config](talosctl_config.md) - Manage the client configuration

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl config node
## talosctl config node
Set the node(s) for the current context
@ -8,7 +8,7 @@ Set the node(s) for the current context
Set the node(s) for the current context
```
osctl config node <endpoint>... [flags]
talosctl config node <endpoint>... [flags]
```
### Options
@ -28,5 +28,5 @@ osctl config node <endpoint>... [flags]
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
* [talosctl config](talosctl_config.md) - Manage the client configuration

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl containers
## talosctl containers
List containers
@ -8,7 +8,7 @@ List containers
List containers
```
osctl containers [flags]
talosctl containers [flags]
```
### Options
@ -30,5 +30,5 @@ osctl containers [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl copy
## talosctl copy
Copy data out from the node
@ -10,12 +10,12 @@ streams it back to the client.
If '-' is given for <local-path>, archive is written to stdout.
Otherwise archive is extracted to <local-path> which should be an empty directory or
osctl creates a directory if <local-path> doesn't exist. Command doesn't preserve
talosctl creates a directory if <local-path> doesn't exist. Command doesn't preserve
ownership and access mode for the files in extract mode, while streamed .tar archive
captures ownership and permission bits.
```
osctl copy <src-path> -|<local-path> [flags]
talosctl copy <src-path> -|<local-path> [flags]
```
### Options
@ -35,5 +35,5 @@ osctl copy <src-path> -|<local-path> [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl dmesg
## talosctl dmesg
Retrieve kernel logs
@ -8,7 +8,7 @@ Retrieve kernel logs
Retrieve kernel logs
```
osctl dmesg [flags]
talosctl dmesg [flags]
```
### Options
@ -30,5 +30,5 @@ osctl dmesg [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -0,0 +1,34 @@
<!-- markdownlint-disable -->
## talosctl gen
Generate CAs, certificates, and private keys
### Synopsis
Generate CAs, certificates, and private keys
### Options
```
-h, --help help for gen
```
### Options inherited from parent commands
```
--context string Context to be used in command
-e, --endpoints strings override default endpoints in Talos configuration
-n, --nodes strings target the specified nodes
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
```
### SEE ALSO
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl gen ca](talosctl_gen_ca.md) - Generates a self-signed X.509 certificate authority
* [talosctl gen config](talosctl_gen_config.md) - Generates a set of configuration files for Talos cluster
* [talosctl gen crt](talosctl_gen_crt.md) - Generates an X.509 Ed25519 certificate
* [talosctl gen csr](talosctl_gen_csr.md) - Generates a CSR using an Ed25519 private key
* [talosctl gen key](talosctl_gen_key.md) - Generates an Ed25519 private key
* [talosctl gen keypair](talosctl_gen_keypair.md) - Generates an X.509 Ed25519 key pair

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen ca
## talosctl gen ca
Generates a self-signed X.509 certificate authority
@ -8,7 +8,7 @@ Generates a self-signed X.509 certificate authority
Generates a self-signed X.509 certificate authority
```
osctl gen ca [flags]
talosctl gen ca [flags]
```
### Options
@ -31,5 +31,5 @@ osctl gen ca [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen config
## talosctl gen config
Generates a set of configuration files for Talos cluster
@ -8,7 +8,7 @@ Generates a set of configuration files for Talos cluster
Generates a set of configuration files for Talos cluster
```
osctl gen config <cluster name> https://<load balancer IP or DNS name> [flags]
talosctl gen config <cluster name> https://<load balancer IP or DNS name> [flags]
```
### Options
@ -36,5 +36,5 @@ osctl gen config <cluster name> https://<load balancer IP or DNS name> [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen crt
## talosctl gen crt
Generates an X.509 Ed25519 certificate
@ -8,7 +8,7 @@ Generates an X.509 Ed25519 certificate
Generates an X.509 Ed25519 certificate
```
osctl gen crt [flags]
talosctl gen crt [flags]
```
### Options
@ -32,5 +32,5 @@ osctl gen crt [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen csr
## talosctl gen csr
Generates a CSR using an Ed25519 private key
@ -8,7 +8,7 @@ Generates a CSR using an Ed25519 private key
Generates a CSR using an Ed25519 private key
```
osctl gen csr [flags]
talosctl gen csr [flags]
```
### Options
@ -30,5 +30,5 @@ osctl gen csr [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen key
## talosctl gen key
Generates an Ed25519 private key
@ -8,7 +8,7 @@ Generates an Ed25519 private key
Generates an Ed25519 private key
```
osctl gen key [flags]
talosctl gen key [flags]
```
### Options
@ -29,5 +29,5 @@ osctl gen key [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl gen keypair
## talosctl gen keypair
Generates an X.509 Ed25519 key pair
@ -8,7 +8,7 @@ Generates an X.509 Ed25519 key pair
Generates an X.509 Ed25519 key pair
```
osctl gen keypair [flags]
talosctl gen keypair [flags]
```
### Options
@ -30,5 +30,5 @@ osctl gen keypair [flags]
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [talosctl gen](talosctl_gen.md) - Generate CAs, certificates, and private keys

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl interfaces
## talosctl interfaces
List network interfaces
@ -8,7 +8,7 @@ List network interfaces
List network interfaces
```
osctl interfaces [flags]
talosctl interfaces [flags]
```
### Options
@ -28,5 +28,5 @@ osctl interfaces [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl kubeconfig
## talosctl kubeconfig
Download the admin kubeconfig from the node
@ -9,7 +9,7 @@ Download the admin kubeconfig from the node.
Kubeconfig will be written to PWD/kubeconfig or [local-path]/kubeconfig if specified.
```
osctl kubeconfig [local-path] [flags]
talosctl kubeconfig [local-path] [flags]
```
### Options
@ -30,5 +30,5 @@ osctl kubeconfig [local-path] [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl list
## talosctl list
Retrieve a directory listing
@ -8,7 +8,7 @@ Retrieve a directory listing
Retrieve a directory listing
```
osctl list [path] [flags]
talosctl list [path] [flags]
```
### Options
@ -32,5 +32,5 @@ osctl list [path] [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl logs
## talosctl logs
Retrieve logs for a process or container
@ -8,7 +8,7 @@ Retrieve logs for a process or container
Retrieve logs for a process or container
```
osctl logs <id> [flags]
talosctl logs <id> [flags]
```
### Options
@ -32,5 +32,5 @@ osctl logs <id> [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl memory
## talosctl memory
Show memory usage
@ -8,7 +8,7 @@ Show memory usage
Show memory usage
```
osctl memory [flags]
talosctl memory [flags]
```
### Options
@ -29,5 +29,5 @@ osctl memory [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl mounts
## talosctl mounts
List mounts
@ -8,7 +8,7 @@ List mounts
List mounts
```
osctl mounts [flags]
talosctl mounts [flags]
```
### Options
@ -28,5 +28,5 @@ osctl mounts [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl processes
## talosctl processes
List running processes
@ -8,7 +8,7 @@ List running processes
List running processes
```
osctl processes [flags]
talosctl processes [flags]
```
### Options
@ -30,5 +30,5 @@ osctl processes [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl read
## talosctl read
Read a file on the machine
@ -8,7 +8,7 @@ Read a file on the machine
Read a file on the machine
```
osctl read <path> [flags]
talosctl read <path> [flags]
```
### Options
@ -28,5 +28,5 @@ osctl read <path> [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl reboot
## talosctl reboot
Reboot a node
@ -8,7 +8,7 @@ Reboot a node
Reboot a node
```
osctl reboot [flags]
talosctl reboot [flags]
```
### Options
@ -28,5 +28,5 @@ osctl reboot [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl reset
## talosctl reset
Reset a node
@ -8,7 +8,7 @@ Reset a node
Reset a node
```
osctl reset [flags]
talosctl reset [flags]
```
### Options
@ -30,5 +30,5 @@ osctl reset [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl restart
## talosctl restart
Restart a process
@ -8,7 +8,7 @@ Restart a process
Restart a process
```
osctl restart <id> [flags]
talosctl restart <id> [flags]
```
### Options
@ -30,5 +30,5 @@ osctl restart <id> [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl routes
## talosctl routes
List network routes
@ -8,7 +8,7 @@ List network routes
List network routes
```
osctl routes [flags]
talosctl routes [flags]
```
### Options
@ -28,5 +28,5 @@ osctl routes [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl service
## talosctl service
Retrieve the state of a service (or all services), control service state
@ -10,7 +10,7 @@ If service ID is specified, default action 'status' is executed which shows stat
With actions 'start', 'stop', 'restart', service state is updated respectively.
```
osctl service [<id> [start|stop|restart|status]] [flags]
talosctl service [<id> [start|stop|restart|status]] [flags]
```
### Options
@ -30,5 +30,5 @@ osctl service [<id> [start|stop|restart|status]] [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl shutdown
## talosctl shutdown
Shutdown a node
@ -8,7 +8,7 @@ Shutdown a node
Shutdown a node
```
osctl shutdown [flags]
talosctl shutdown [flags]
```
### Options
@ -28,5 +28,5 @@ osctl shutdown [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl stats
## talosctl stats
Get processes stats
@ -8,7 +8,7 @@ Get processes stats
Get processes stats
```
osctl stats [flags]
talosctl stats [flags]
```
### Options
@ -30,5 +30,5 @@ osctl stats [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl time
## talosctl time
Gets current server time
@ -8,7 +8,7 @@ Gets current server time
Gets current server time
```
osctl time [--check server] [flags]
talosctl time [--check server] [flags]
```
### Options
@ -29,5 +29,5 @@ osctl time [--check server] [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl upgrade
## talosctl upgrade
Upgrade Talos on the target node
@ -8,7 +8,7 @@ Upgrade Talos on the target node
Upgrade Talos on the target node
```
osctl upgrade [flags]
talosctl upgrade [flags]
```
### Options
@ -30,5 +30,5 @@ osctl upgrade [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl validate
## talosctl validate
Validate config
@ -8,7 +8,7 @@ Validate config
Validate config
```
osctl validate [flags]
talosctl validate [flags]
```
### Options
@ -30,5 +30,5 @@ osctl validate [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

View File

@ -1,5 +1,5 @@
<!-- markdownlint-disable -->
## osctl version
## talosctl version
Prints the version
@ -8,7 +8,7 @@ Prints the version
Prints the version
```
osctl version [flags]
talosctl version [flags]
```
### Options
@ -30,5 +30,5 @@ osctl version [flags]
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl](talosctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos

Some files were not shown because too many files have changed in this diff Show More