crossplane

1
/*
2
Copyright 2023 The Crossplane Authors.
3

4
Licensed under the Apache License, Version 2.0 (the "License");
5
you may not use this file except in compliance with the License.
6
You may obtain a copy of the License at
7

8
    http://www.apache.org/licenses/LICENSE-2.0
9

10
Unless required by applicable law or agreed to in writing, software
11
distributed under the License is distributed on an "AS IS" BASIS,
12
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
See the License for the specific language governing permissions and
14
limitations under the License.
15
*/
16

17
// Package xpkg contains Crossplane packaging commands.
18
package xpkg
19

20
// TODO(lsviben) add the rest of the commands from up (batch, xpextract).
21

22
// Cmd contains commands for interacting with xpkgs.
23
type Cmd struct {
24
	// Keep subcommands sorted alphabetically.
25
	Build   buildCmd   `cmd:"" help:"Build a new package."`
26
	Install installCmd `cmd:"" help:"Install a package in a control plane."`
27
	Login   loginCmd   `cmd:"" help:"Login to the default package registry."`
28
	Logout  logoutCmd  `cmd:"" help:"Logout of the default package registry."`
29
	Push    pushCmd    `cmd:"" help:"Push a package to a registry."`
30
	Update  updateCmd  `cmd:"" help:"Update a package in a control plane."`
31
}
32

33
// Help prints out the help for the xpkg command.
34
func (c *Cmd) Help() string {
35
	return `
36
Crossplane can be extended using packages. Crossplane packages are called xpkgs.
37
Crossplane supports configuration, provider and function packages. 
38

39
A package is an opinionated OCI image that contains everything needed to extend
40
a Crossplane control plane with new functionality. For example installing a
41
provider package extends Crossplane with support for new kinds of managed
42
resource (MR).
43

44
See https://docs.crossplane.io/latest/concepts/packages for more information.
45
`
46
}
47