Plan Variables

[edit on GitHub]

The following variables can be used in your plans to help get binaries and libraries to build and install in the correct locations in your package. The values for the variables listed below are default values or read-only values.

pkg_prefix

The absolute path for your package.

pkg_dirname

The directory created when Habitat extracts an archive.

If a .tar file extracts to a directory that’s different from the filename, then you would need to override this value to match the directory name created during extraction.

Default value: ${pkg_name}-${pkg_version}

pkg_svc_path

Where the running service is located.

Read-only value: ${HAB_ROOT_PATH}/svc/${pkg_name}

pkg_svc_data_path

Where the running service data is located.

Read-only value: ${pkg_svc_path}/data

pkg_svc_files_path

Where the gossiped configuration files are located.

Read-only value: ${pkg_svc_path}/files

pkg_svc_var_path

Where the running service variable data is located.

Read-only value: ${pkg_svc_path}/var

pkg_svc_config_path

Where the running service configuration is located.

Read-only value: ${pkg_svc_path}/config

pkg_svc_static_path

Where the running service static data is located.

Read-only value: ${pkg_svc_path}/static

CACHE_PATH

A temporary directory that will be clean on every build.

Read-only value: ${HAB_CACHE_SRC_PATH}/${pkg_dirname}

HAB_CACHE_SRC_PATH

The default path where source archives are downloaded, extracted, and compiled.

Read-only value: ${HAB_ROOT_PATH}/cache/src

HAB_CACHE_ARTIFACT_PATH

The default download root path for packages.

Read-only value: ${HAB_ROOT_PATH}/cache/artifacts

HAB_PKG_PATH

The root path containing all locally installed packages.

Read-only value: ${HAB_ROOT_PATH}/pkgs

PLAN_CONTEXT

The location on your local dev machine for the files in your plan directory.

CFLAGS

C compiler options.

LDFLAGS

C linker options.

PREFIX

Where to install the software; same as pkg_prefix.

LD_RUN_PATH

Where to find the binaries at run time.