Deploy Path-Based Local Dependencies
Example
warning
Using local projects with path
option makes the configuration in devspace.yaml
harder to share compared to git
based dependencies and is therefore discouraged.
source
source.path
The source.path
option expects a string with a relative path to a folder that contains a devspace.yaml
which marks a project that is a dependency of the project referencing it.
Example: Local Project as Dependency
Explanation:
- Whenever you run
devspace deploy
ordevspace dev
, DevSpace will:- Load the
devspace.yaml
files of both dependencies and resolve their dependencies respectively. - Deploy both projects according to their
devspace.yaml
files.
- Load the
General Options
profile
The profile
option expects a string with the name of a profile defined in the devspace.yaml
of this dependency. When configuring this option, this profile will be used to deploy the dependency, i.e. the dependency will be deployed similar to running devspace deploy -p [profile]
within the folder of the dependency.
Example: Use Config Profile for Dependency
skipBuild
The skipBuild
option expects a boolean that defines if the image building process should be skipped when deploying this dependency. This is often useful if you rather want to use the tags that are defined in the deployment files (e.g. manifests or helm charts) which may reference more stable, production-like versions of the images.
info
Using skipBuild
is useful when trying to speed up the dependency deployment process, especially when working with many dependencies that frequently change.
skipBuild
Default Value For Example: Skip Build for Dependency
ignoreDependencies
The ignoreDependencies
option expects a boolean that defines if the dependencies of this dependencies should not be resolved and deployed.
info
Using ignoreDependencies
can be useful to prevent problematic circular dependencies.
ignoreDependencies
Default Value For Example: Ignore Dependencies of Dependency
name
The name
option is optional and expects a string stating the name of this dependency.
note
Adding a name
for a dependency makes it possible to reference the dependency using flags, e.g.
namespace
The namespace
option is optional and expects a string stating a namespace that should be used to deploy the dependency to.
note
By default, DevSpace deploys project dependencies in the same namespace as the project itself.
info
You should only use the namespace
option if you are an advanced user because using this option requires any user that deploys this project to be able to create this namespace during the deployment process or to have access to the namespace with the current kube-context, if the namespace already exists.
vars
The vars
option expects an array of objects with name and value of variables defined in the devspace.yaml
of this dependency. When configuring this option, the variables will be overriden similar to passing variables via the --var
flag to devspace.
It is also useful to deploy the same dependency multiple times with just small adjustments.