Skip to content

Add note about the deploy_tag in the onprem documentation #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adreanneb merged 5 commits into from
May 2, 2025
Merged

Add note about the deploy_tag in the onprem documentation #15

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
26ce1b0
Add deploy tag
palade May 1, 2025
3d3b71b
Merge branch 'main' into precendence_in_onprem
palade May 2, 2025
3c0dddd
Updated the text
palade May 2, 2025
01adefd
Merge branch 'main' into precendence_in_onprem
palade May 2, 2025
0152913
Update path
palade May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/developer_guide/set_up_dev_env/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,11 @@ Your development machine must have the following software installed:
- Download the appropriate asdf binary for your operating system/architecture
combo from the `GitHub releases page
<https://github.com/asdf-vm/asdf/releases>`_. Ensure to place it in a
directory on your $PATH.

- Prepend ``$ASDF_DATA_DIR/shims`` to your ``$PATH`` environment variable.
directory on your ``$PATH``. For example, you can prepend
``$ASDF_DATA_DIR/shims`` to your ``$PATH`` environment variable:

.. code-block:: bash

export PATH="${ASDF_DATA_DIR:-$HOME/.asdf}/shims:$PATH"

- Docker\* software
Expand Down Expand Up @@ -206,6 +205,9 @@ Build repo archive and installer packages and move them to default directories:

Ensure that the ``TF_VAR_deploy_tag`` is set to the correct version that matches the version of Debian\* packages.
Due to Debian versioning, if you are building from a tagged version branch (e.g., v3.0.0), the ``mage build:all`` command will remove the v prefix so you may need to manually export ``TF_VAR_deploy_tag``.
If ``TF_VAR_deploy_tag`` is set, ensure that ``deploy_tag`` is not defined in
the ``terraform/orchestrator/terraform.tfvars`` file due to Terraform's
precedence rules.

Edit ``terraform/orchestrator/terraform.tfvars`` to use locally built
artifacts:
Expand Down