Skip to main content

conveyor project update

Update an existing project

Synopsis​

Update an existing project. You can update the airflow version or description of a project using this command.

conveyor project update [flags]

Examples​

Allows updating several properties of an existing project.

To update the description, pass the description directly or pass the location of a file containing the description.
In the description you can use markdown syntax.

$ conveyor project update --description="This is the description of the project"
$ conveyor project update --description=file://README.md


To update the default IAM identity, you can pass a templated string as:

$ conveyor project update --default-identity="my-default-identity"

You can let Conveyor generate the identity dynamically based on the {{ .Env }} template parameter.
This allows to you specify a separate identity per environment, or construct the identity based on this parameter.

You can use an if-test as in this example (note that "production" is surrounded by double quotes):

$ 	--default-identity='{{if eq .Env "production"}}my-production-role{{else}}my-development-role{{end}}'

The following example uses slice to extract a substring from the environment value.
This template will generate "my-role-for-pro" in an environment named "production":

$ 	--default-identity="my-role-for-{{slice .Env 0 3}}"

Options​

      --airflow-version string           The Airflow version for the project. Currently, only Airflow 2 is supported. (default "2")
      --default-ide-config string        The location for the default ide config yaml file
      --default-ide-environment string   The default environment in which IDEs will be created for this project
      --default-identity string          The default IAM identity for the project, can be templated.
      --description string               The description of your project
      --git-repo string                  Configure the git repository of your project
      --git-sub-folder string            Configures that the project is using a sub folder of your git repo, this makes the IDE open that sub folder automatically
  -h, --help                             help for update

Options inherited from parent commands​

      --debug                        Show debug output
      --no-browser NO_BROWSER=true   Do not automatically open a browser at login instead print the url to the command line. You can also use the environment variable NO_BROWSER=true.
  -o, --output string                Change the output. Valid options are table or json (default "table")
      --quiet QUIET=true             Quiet down the output. You can also use the environment variable QUIET=true.

See also​