func/docs/reference/func_deploy.md

func deploy

Deploy a function

Synopsis

NAME func deploy - Deploy a function

SYNOPSIS func deploy [-R|--remote] [-r|--registry] [-i|--image] [-n|--namespace] [-e|env] [-g|--git-url] [-t|git-branch] [-d|--git-dir] [-b|--build] [--builder] [--builder-image] [-p|--push] [--platform] [-c|--confirm] [-v|--verbose]

DESCRIPTION

Deploys a function to the currently configured Knative-enabled cluster.

By default the function in the current working directory is deployed, or at
the path defined by --path.

A function which was previously deployed will be updated when re-deployed.

The function is built into a container for transport to the destination
cluster by way of a registry.  Therefore --registry must be provided or have
previously been configured for the function. This registry is also used to
determine the final built image tag for the function.  This final image name
can be provided explicitly using --image, in which case it is used in place
of --registry.

To run deploy using an interactive mode, use the --confirm (-c) option.
This mode is useful for the first deployment in particular, since subsdequent
deployments remember most of the settings provided.

Building
  By default the function will be built if it has not yet been built, or if
  changes are detected in the function's source.  The --build flag can be
  used to override this behavior and force building either on or off.

Pushing
  By default the function's image will be pushed to the configured container
  registry after being successfully built.  The --push flag can be used
  to disable pushing.  This could be used, for example, to trigger a redeploy
  of a service without needing to build, or even have the container available
  locally with 'func deploy --build=false --push==false'.

Remote
  Building and pushing (deploying) is by default run on localhost.  This
  process can also be triggered to run remotely in a Tekton-enabled cluster.
  The --remote flag indicates that a build and deploy pipeline should be
  invoked in the remote.  Deploying with 'func deploy --remote' will
  send the function's source code to be built and deployed by the cluster,
  eliminating the need for a local container engine.  To trigger deployment
  of a git repository instead of local source, combine with '--git-url':
  'func deploy --remote --git-url=git.example.com/alice/f.git'

EXAMPLES

o Deploy the function
  $ func deploy

o Deploy the function using interactive prompts. This is useful for the first
  deployment, since most settings will be remembered for future deployments.
  $ func deploy -c

o Deploy the function in the current working directory.
  The function image will be pushed to "ghcr.io/alice/<Function Name>"
  $ func deploy --registry ghcr.io/alice

o Deploy the function in the current working directory, manually specifying
  the final image name and target cluster namespace.
  $ func deploy --image ghcr.io/alice/myfunc --namespace myns

o Deploy the current function's source code by sending it to the cluster to
  be built and deployed:
  $ func deploy --remote

o Trigger a remote deploy, which instructs the cluster to build and deploy
  the function in the specified git repository.
  $ func deploy --remote --git-url=https://example.com/alice/myfunc.git

o Deploy the function, rebuilding the image even if no changes have been
  detected in the local filesystem (source).
  $ func deploy --build

o Deploy without rebuilding, even if changes have been detected in the
  local filesystem.
  $ func deploy --build=false

o Redeploy a function which has already been built and pushed. Works without
  the use of a local container engine.  For example, if the function was
  manually deleted from the cluster, it can be quickly redeployed with:
  $ func deploy --build=false --push=false

func deploy

Options

      --build string[="true"]   Build the function. [auto|true|false]. (Env: $FUNC_BUILD) (default "auto")
  -b, --builder string          Builder to use when creating the function's container. Currently supported builders are "pack" and "s2i". (default "pack")
      --builder-image string    Specify a custom builder image for use by the builder other than its default. ($FUNC_BUILDER_IMAGE)
  -c, --confirm                 Prompt to confirm options interactively (Env: $FUNC_CONFIRM)
  -e, --env stringArray         Environment variable to set in the form NAME=VALUE. You may provide this flag multiple times for setting multiple environment variables. To unset, specify the environment variable name followed by a "-" (e.g., NAME-).
  -t, --git-branch string       Git revision (branch) to be used when deploying via a git repository (Env: $FUNC_GIT_BRANCH)
  -d, --git-dir string          Directory in the repo to find the function (default is the root) (Env: $FUNC_GIT_DIR)
  -g, --git-url string          Repo url to push the code to be built (Env: $FUNC_GIT_URL)
  -h, --help                    help for deploy
  -i, --image string            Full image name in the form [registry]/[namespace]/[name]:[tag]@[digest]. This option takes precedence over --registry. Specifying digest is optional, but if it is given, 'build' and 'push' phases are disabled. (Env: $FUNC_IMAGE)
  -n, --namespace string        Deploy into a specific namespace. Will use function's current namespace by default if already deployed, and the currently active namespace if it can be determined. (Env: $FUNC_NAMESPACE)
  -p, --path string             Path to the function.  Default is current directory (Env: $FUNC_PATH)
      --platform string         Optionally specify a specific platform to build for (e.g. linux/amd64). (Env: $FUNC_PLATFORM)
  -u, --push                    Push the function image to registry before deploying. (Env: $FUNC_PUSH) (default true)
  -r, --registry string         Container registry + registry namespace. (ex 'ghcr.io/myuser').  The full image name is automatically determined using this along with function name. (Env: $FUNC_REGISTRY)
      --remote                  Trigger a remote deployment.  Default is to deploy and build from the local system (Env: $FUNC_REMOTE)
  -v, --verbose                 Print verbose logs ($FUNC_VERBOSE)

SEE ALSO

• func - func manages Knative Functions