6.7 KiB
CLI Commands
init
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.
Similar kn command: none.
faas init <path> [-l <runtime> -t <trigger>]
When run as a kn plugin.
kn faas init <path> [-l <runtime> -t <trigger>]
build
Builds the Function project in the current directory. Reads the faas.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 faas.yaml file so that subsequent invocations do not require the user to specify these again.
Similar kn command: none.
faas build [-i <image> -r <registry> -p <path>]
When run as a kn plugin.
kn faas 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 faas build. The user may specify a path to the project directory using the --path or -p flag.
Similar kn command: none.
faas run
When run as a kn plugin.
kn faas run [-p <path>]
deploy
Builds and 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 faas.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 faas init 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.
The namespace into which the project is deployed defaults to the value in the faas.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 faas.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 faas deploy command has a similar end result, but is definitely easier for a user just getting started to be successful with.
faas deploy [-n <namespace> -p <path> -i <image> -r <registry>]
When run as a kn plugin.
kn faas deploy [-n <namespace> -p <path> -i <image> -r <registry>]
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 faas.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 faas.yaml.
Similar kn command: kn service describe NAME [flags]. This flag provides a lot of nice information not available in faas describe, such as revisions, age, annotations and labels. This command should be renamed to make it distinct from kn - e.g. faas status.
faas describe [-f <format> -n <namespace> -p <path>]
When run as a kn plugin.
kn faas describe [-f <format> -n <namespace> -p <path>]
list
Lists all deployed functions. The namespace defaults to the value in faas.yaml or the namespace currently active in the user's Kubernetes configuration. The namespace defaults to the value in faas.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 faas.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 faas list will only display the boson Functions that have been deployed. Consider improving the output of the faas list command so that it is at least as informative as kn service list.
faas list [-n <namespace> -p <path>]
When run as a kn plugin.
kn faas list [-n <namespace> -p <path>]
create
Creates a new Function project at path. If path does not exist, it is created. The function name is the name of the leaf directory at path. After creating the project, it builds a container image and deploys it. This command wraps init, build and deploy all up into one command.
The user may specify the runtime, trigger, image name, image registry, and namespace as flags on the command line. If the image name and image registry are both unspecified, the user will be prompted for a registry name, and the image name can be inferred from that plus the function name. The function name, namespace and image name are all persisted in the project configuration file faas.yaml.
Similar kn command: none.
faas create <path> -r <registry> -l <runtime> -t <trigger> -i <image> -n <namespace>
When run as a kn plugin.
kn faas create <path> -r <registry> -l <runtime> -t <trigger> -i <image> -n <namespace>
delete
Removes a deployed function from the cluster. The user may specify a function by name, path or if neither of those are provided, the current directory will be searched for a faas.yaml configuration file to determine the function to be removed. The namespace defaults to the value in faas.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 faas.yaml.
Similar kn command: kn service delete NAME [flags].
faas delete <name> [-n namespace, -p path]
When run as a kn plugin.
kn faas delete <name> [-n namespace, -p path]