6.2 KiB
CLI Commands
create
Creates a new Function project at path. If path is unspecified, assumes the current directory. If path does not exist, it will be created. The function name is the name of the leaf directory at path. The user can specify the runtime and trigger with flags.
Function name must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is 'a-z0-9?').
Similar kn command: none.
func create <path> [-l <runtime> -t <trigger>]
When run as a kn plugin.
kn func create <path> [-l <runtime> -t <trigger>]
build
Builds the Function project in the current directory. Reads the func.yaml file to determine image name and registry. If both of these values are unset in the configuration file, the user is prompted to provide a registry, from there an image name can be derived. The image name and registry may also be specified as flags, as can the path to the project.
The value(s) provided for image and registry are persisted to the func.yaml file so that subsequent invocations do not require the user to specify these again.
Similar kn command: none.
func build [-i <image> -r <registry> -p <path>]
When run as a kn plugin.
kn func build [-i <image> -r <registry> -p <path>]
run
Runs the Function project locally in the container. If a container has not yet been created, prompts the user to run func build. The user may specify a path to the project directory using the --path or -p flag.
Similar kn command: none.
func run
When run as a kn plugin.
kn func run [-p <path>]
deploy
Deploys the Function project in the current directory. The user may specify a path to the project directory using the --path or -p flag. Reads the func.yaml configuration file to determine the image name. An image and registry may be specified on the command line using the --image or -i and --registry or -r flag.
Derives the service name from the project name. There is no mechanism by which the user can specify the service name. The user must have already initialized the function using func create or they will encounter an error.
If the Function is already deployed, it is updated with a new container image that is pushed to a container image registry, and the Knative Service is updated.
By default the Function image to be deployed is also built. The build can be skipped by specifying --build=false.
The namespace into which the project is deployed defaults to the value in the func.yaml configuration file. If NAMESPACE is not set in the configuration, the namespace currently active in the Kubernetes configuration file will be used. The namespace may be specified on the command line using the --namespace or -n flag, and if so this will overwrite the value in the func.yaml file.
Similar kn command: kn service create NAME --image IMAGE [flags]. This command allows a user to deploy a Knative Service by specifying an image, typically one hosted on a public container registry such as docker.io. The deployment options which the kn command affords the user are quite broad. The kn command in this case is quite effective for a power user. The func deploy command has a similar end result, but is definitely easier for a user just getting started to be successful with.
func deploy [-n <namespace> -p <path> -i <image> -r <registry> -b=true|false]
When run as a kn plugin.
kn func deploy [-n <namespace> -p <path> -i <image> -r <registry> -b=true|false]
describe
Prints the name, route and any event subscriptions for a deployed Function. The user may also specify the name of the function to describe. The namespace defaults to the value in func.yaml or the namespace currently active in the user's Kubernetes configuration. The namespace may be specified on the command line, and if so this will overwrite the value in func.yaml.
Similar kn command: kn service describe NAME [flags]. This flag provides a lot of nice information not available in func describe, such as revisions, age, annotations and labels. This command should be renamed to make it distinct from kn - e.g. func status.
func describe [-o <output> -n <namespace> -p <path>]
When run as a kn plugin.
kn func describe [-o <output> -n <namespace> -p <path>]
list
Lists all deployed functions. The namespace defaults to the value in func.yaml or the namespace currently active in the user's Kubernetes configuration. The namespace defaults to the value in func.yaml or the namespace currently active in the user's Kubernetes configuration. The namespace may be specified on the command line, and if so this will overwrite the value in func.yaml.
Similar kn command: kn service list [name] [flags]. This command lists all deployed Knative Services. As with other kn commands that have similar functionality, there is more information and flexibilty in the kn command. However, kn will return all Services, while func list will only display the boson functions that have been deployed. Consider improving the output of the func list command so that it is at least as informative as kn service list.
func list [-n <namespace> -p <path>]
When run as a kn plugin.
kn func list [-n <namespace> -p <path>]
delete
Removes a deployed function from the cluster. The user may specify a function by name, path. If both of those are provided the command will not be executed and user will receive an error message. If neither of those are provided, the current directory will be searched for a func.yaml configuration file to determine the function to be removed. The namespace defaults to the value in func.yaml or the namespace currently active in the user's Kubernetes configuration. The namespace may be specified on the command line, and if so this will overwrite the value in func.yaml.
Similar kn command: kn service delete NAME [flags].
func delete <name> [-n namespace, -p path]
When run as a kn plugin.
kn func delete <name> [-n namespace, -p path]