crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: renaming kubectl plugin to crossplane CLI (#562)

This commit is contained in:
Philippe Scorsolini 2023-10-04 17:00:20 +02:00 committed by GitHub
parent 883ded5096
commit 9637e10f54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 65 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/knowledge-base/guides/troubleshoot.md
View File

@ -4,11 +4,11 @@ weight: 306
--- ---
## Requested Resource Not Found ## Requested Resource Not Found
If you use the kubectl Crossplane plugin to install a `Provider` or If you use the Crossplane CLI to install a `Provider` or
`Configuration` (e.g. `kubectl crossplane install provider `Configuration` (e.g. `crossplane install provider
xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0`) and get `the server xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0`) and get `the server
could not find the requested resource` error, more often than not, that is an could not find the requested resource` error, more often than not, that is an
indicator that the kubectl Crossplane you're using is outdated. In other words indicator that the Crossplane CLI you're using is outdated. In other words
some Crossplane API has been graduated from alpha to beta or stable and the old some Crossplane API has been graduated from alpha to beta or stable and the old
plugin is not aware of this change. plugin is not aware of this change.

12
content/master/concepts/packages.md
View File

@ -136,7 +136,7 @@ To build a Provider package, navigate to the package root directory and execute
the following command: the following command:
``` ```
kubectl crossplane build provider crossplane build provider
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -187,7 +187,7 @@ To build a Configuration package, navigate to the package root directory and
execute the following command: execute the following command:
``` ```
kubectl crossplane build configuration crossplane build configuration
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -201,13 +201,13 @@ registry is not specified they will be pushed to Docker Hub.
To push a Provider package, execute the following command: To push a Provider package, execute the following command:
``` ```
kubectl crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To push a Configuration package, execute the following command: To push a Configuration package, execute the following command:
``` ```
kubectl crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
> Note: Both of the above commands assume a single `.xpkg` file exists in the > Note: Both of the above commands assume a single `.xpkg` file exists in the
@ -222,13 +222,13 @@ Packages can be installed into a Crossplane cluster using the Crossplane CLI.
To install a Provider package, execute the following command: To install a Provider package, execute the following command:
``` ```
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To install a Configuration package, execute the following command: To install a Configuration package, execute the following command:
``` ```
kubectl crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
Packages can also be installed manually by creating a `Provider` or Packages can also be installed manually by creating a `Provider` or

12
content/v1.11/concepts/packages.md
View File

@ -132,7 +132,7 @@ To build a Provider package, navigate to the package root directory and execute
the following command: the following command:
``` ```
kubectl crossplane build provider crossplane build provider
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -183,7 +183,7 @@ To build a Configuration package, navigate to the package root directory and
execute the following command: execute the following command:
``` ```
kubectl crossplane build configuration crossplane build configuration
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -197,13 +197,13 @@ registry is not specified they will be pushed to Docker Hub.
To push a Provider package, execute the following command: To push a Provider package, execute the following command:
``` ```
kubectl crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To push a Configuration package, execute the following command: To push a Configuration package, execute the following command:
``` ```
kubectl crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
> Note: Both of the above commands assume a single `.xpkg` file exists in the > Note: Both of the above commands assume a single `.xpkg` file exists in the
@ -218,13 +218,13 @@ Packages can be installed into a Crossplane cluster using the Crossplane CLI.
To install a Provider package, execute the following command: To install a Provider package, execute the following command:
``` ```
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To install a Configuration package, execute the following command: To install a Configuration package, execute the following command:
``` ```
kubectl crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
Packages can also be installed manually by creating a `Provider` or Packages can also be installed manually by creating a `Provider` or

12
content/v1.11/getting-started/provider-aws-part-3.md
View File

@ -599,14 +599,14 @@ extension.
wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
chmod +x install.sh chmod +x install.sh
./install.sh ./install.sh
sudo mv kubectl-crossplane /usr/bin sudo mv crossplane /usr/local/bin
``` ```
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell ```shell
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -619,11 +619,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` CLI to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-aws-quickstart/ --name="crossplane-aws-quickstart" crossplane build configuration -f crossplane-aws-quickstart/ --name="crossplane-aws-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-aws-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-aws-quickstart` directory.

13
content/v1.11/getting-started/provider-azure-part-3.md
View File

@ -768,16 +768,17 @@ extension.
wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
chmod +x install.sh chmod +x install.sh
./install.sh ./install.sh
sudo mv crossplane /usr/local/bin
``` ```
Follow the directions and move the `kubectl-crossplane` binary to the correct Follow the directions and move the `crossplane` binary to the correct
directory. directory.
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell {copy-lines="1"} ```shell {copy-lines="1"}
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -790,11 +791,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` CLI to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-azure-quickstart/ --name="crossplane-azure-quickstart" crossplane build configuration -f crossplane-azure-quickstart/ --name="crossplane-azure-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-azure-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-azure-quickstart` directory.

12
content/v1.11/getting-started/provider-gcp-part-3.md
View File

@ -619,14 +619,14 @@ extension.
wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
chmod +x install.sh chmod +x install.sh
./install.sh ./install.sh
sudo mv kubectl-crossplane /usr/bin sudo mv crossplane /usr/local/bin
``` ```
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell ```shell
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -639,11 +639,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` CLI to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-gcp-quickstart/ --name="crossplane-gcp-quickstart" crossplane build configuration -f crossplane-gcp-quickstart/ --name="crossplane-gcp-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-gcp-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-gcp-quickstart` directory.

12
content/v1.12/concepts/packages.md
View File

@ -132,7 +132,7 @@ To build a Provider package, navigate to the package root directory and execute
the following command: the following command:
``` ```
kubectl crossplane build provider crossplane build provider
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -183,7 +183,7 @@ To build a Configuration package, navigate to the package root directory and
execute the following command: execute the following command:
``` ```
kubectl crossplane build configuration crossplane build configuration
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -197,13 +197,13 @@ registry is not specified they will be pushed to Docker Hub.
To push a Provider package, execute the following command: To push a Provider package, execute the following command:
``` ```
kubectl crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To push a Configuration package, execute the following command: To push a Configuration package, execute the following command:
``` ```
kubectl crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
> Note: Both of the above commands assume a single `.xpkg` file exists in the > Note: Both of the above commands assume a single `.xpkg` file exists in the
@ -218,13 +218,13 @@ Packages can be installed into a Crossplane cluster using the Crossplane CLI.
To install a Provider package, execute the following command: To install a Provider package, execute the following command:
``` ```
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To install a Configuration package, execute the following command: To install a Configuration package, execute the following command:
``` ```
kubectl crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
Packages can also be installed manually by creating a `Provider` or Packages can also be installed manually by creating a `Provider` or

12
content/v1.12/getting-started/provider-aws-part-3.md
View File

@ -612,14 +612,14 @@ extension.
```shell ```shell
curl "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" curl "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
./install.sh ./install.sh
sudo mv kubectl-crossplane /usr/bin sudo mv crossplane /usr/local/bin
``` ```
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell ```shell
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -632,11 +632,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` CLI to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-aws-quickstart/ --name="crossplane-aws-quickstart" crossplane build configuration -f crossplane-aws-quickstart/ --name="crossplane-aws-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-aws-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-aws-quickstart` directory.

13
content/v1.12/getting-started/provider-azure-part-3.md
View File

@ -768,16 +768,17 @@ extension.
wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
chmod +x install.sh chmod +x install.sh
./install.sh ./install.sh
sudo mv crossplane /usr/local/bin
``` ```
Follow the directions and move the `kubectl-crossplane` binary to the correct Follow the directions and move the `crossplane` binary to the correct
directory. directory.
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell {copy-lines="1"} ```shell {copy-lines="1"}
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -790,11 +791,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` CLI to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-azure-quickstart/ --name="crossplane-azure-quickstart" crossplane build configuration -f crossplane-azure-quickstart/ --name="crossplane-azure-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-azure-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-azure-quickstart` directory.

12
content/v1.12/getting-started/provider-gcp-part-3.md
View File

@ -619,14 +619,14 @@ extension.
wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh" wget "https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh"
chmod +x install.sh chmod +x install.sh
./install.sh ./install.sh
sudo mv kubectl-crossplane /usr/bin sudo mv crossplane /usr/local/bin
``` ```
Verify the Crossplane command-line installed with `kubectl crossplane --help` Verify the Crossplane command-line installed with `crossplane --help`
```shell ```shell
kubectl crossplane --help crossplane --help
Usage: kubectl crossplane <command> Usage: crossplane <command>
A command line tool for interacting with Crossplane. A command line tool for interacting with Crossplane.
@ -639,11 +639,11 @@ Flags:
### Build a configuration package ### Build a configuration package
Use the `kubectl crossplane` command to create an `.xpkg` file containing the Use the `crossplane` command to create an `.xpkg` file containing the
custom APIs and Crossplane configuration. custom APIs and Crossplane configuration.
```shell ```shell
kubectl crossplane build configuration -f crossplane-gcp-quickstart/ --name="crossplane-gcp-quickstart" crossplane build configuration -f crossplane-gcp-quickstart/ --name="crossplane-gcp-quickstart"
``` ```
Now an `.xpkg` OCI image is inside the `crossplane-gcp-quickstart` directory. Now an `.xpkg` OCI image is inside the `crossplane-gcp-quickstart` directory.

12
content/v1.13/concepts/packages.md
View File

@ -136,7 +136,7 @@ To build a Provider package, navigate to the package root directory and execute
the following command: the following command:
``` ```
kubectl crossplane build provider crossplane build provider
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -187,7 +187,7 @@ To build a Configuration package, navigate to the package root directory and
execute the following command: execute the following command:
``` ```
kubectl crossplane build configuration crossplane build configuration
``` ```
If the Provider package is valid, you will see a file with the `.xpkg` If the Provider package is valid, you will see a file with the `.xpkg`
@ -201,13 +201,13 @@ registry is not specified they will be pushed to Docker Hub.
To push a Provider package, execute the following command: To push a Provider package, execute the following command:
``` ```
kubectl crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane push provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To push a Configuration package, execute the following command: To push a Configuration package, execute the following command:
``` ```
kubectl crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane push configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
> Note: Both of the above commands assume a single `.xpkg` file exists in the > Note: Both of the above commands assume a single `.xpkg` file exists in the
@ -222,13 +222,13 @@ Packages can be installed into a Crossplane cluster using the Crossplane CLI.
To install a Provider package, execute the following command: To install a Provider package, execute the following command:
``` ```
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0 crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0
``` ```
To install a Configuration package, execute the following command: To install a Configuration package, execute the following command:
``` ```
kubectl crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0 crossplane install configuration xpkg.upbound.io/crossplane-contrib/my-org-infra:v0.1.0
``` ```
Packages can also be installed manually by creating a `Provider` or Packages can also be installed manually by creating a `Provider` or