Skip to content
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.

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

remove config branch must be mapped to env requirement #421

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion public-site/docs/guides/deploy-only/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The documentation will use the second option.
## The `radixconfig.yaml` file

:::tip
Radix only reads `radixconfig.yaml` from the branch we set as the `Config Branch` in the application registration form. If the file is changed in other branches, those changes will be ignored. The `Config Branch` must be mapped to an environment in `radixconfig.yaml`
Radix only reads `radixconfig.yaml` from the branch we set as the `Config Branch` in the application configuration form. If the file is changed in other branches, those changes will be ignored.
:::

The major difference between a `deploy-only` and a regular Radix application, is that the [`image`](/radix-config/index.md#image) property in `radixconfig.yaml` is set for all components and jobs.
Expand Down
8 changes: 2 additions & 6 deletions public-site/docs/radix-config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ toc_max_heading_level: 4
In order for Radix to configure your application it needs a configuration file. By default, it is expected to be located in the root of the application repository, has a name `radixconfig.yaml` and be in YAML or JSON format - in either case, it must have the `.yaml` or `.yml` extension (the name and extension should be exactly same as for the file in the GitHub repository). The name of the file and its location in the repository can be different. It can also be changed later on the Radix web-console configuration page for the application. Read more in the [monorepo](/guides/monorepo) guide.

:::tip
Radix only reads `radixconfig.yaml` from the branch, set as the `Config Branch` in the application registration form. If the file is changed in other branches, those changes will be ignored. The `Config Branch` must be mapped to an environment in the configuration file.
Radix only reads `radixconfig.yaml` from the branch we set as the `Config Branch` in the application registration form. If the file is changed in other branches, those changes will be ignored.
:::

The basic format of the file is this; the configuration keys are explained in the Reference section below:
Expand Down Expand Up @@ -82,7 +82,7 @@ Make sure you never store secrets or confidential information in any intermitent
:::

### `secrets`
`secrets` - (optional) add secrets to Radix config `radixconfig.yaml` in the branch defined as `Config Branch` for your application. This will trigger a new build. This build will fail as no specified build secret has been set. You will now be able to set the secret **values** in the configuration section of your app in the Radix Web Console. These secrets also can be used in the [sub-pipelines](/guides/sub-pipeline).
`secrets` - (optional) Defines secrets to be used in Dockerfiles or [sub-pipelines](/guides/sub-pipeline). Secrets values must be set in Radix Web Console. `build-deploy` jobs will fail if not all secret values are set.

:::tip
* When an option `useBuildKit: false`, to ensure that multiline build secrets are handled correct by the build, **all** build secrets are passed as `ARG`-s during container build, base-64 encoded (they need to be decoded before use).
Expand Down Expand Up @@ -141,10 +141,6 @@ spec:

The `environments` section of the spec lists the environments for the application.

:::tip
The `Config Branch` set in the application registration form **must** be mapped to the name of one of the `environments`.
:::

### `name`

The name of the environment. Can be `dev`, `qa`, `production` etc.
Expand Down
2 changes: 1 addition & 1 deletion public-site/docs/start/config-your-app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The way we use branches and tags in our repository depends on what type of workf
A 📖 [`radixconfig.yaml`](/radix-config/index.md) file that defines the running environments, which specifies how our application is built and deployed. By default, it is in the root directory of our repository.

:::tip
Radix only reads `radixconfig.yaml` from the branch we set as the `Config Branch` in the application registration/configuration form. If the file is changed in other branches, those changes will be ignored. The `Config Branch` must be mapped to an environment in `radixconfig.yaml`
Radix only reads `radixconfig.yaml` from the branch we set as the `Config Branch` in the application registration form. If the file is changed in other branches, those changes will be ignored.
:::

If you are unfamiliar with YAML, it is fine to write the configuration as JSON instead — just keep the same filename.
Expand Down
2 changes: 1 addition & 1 deletion public-site/docs/start/radix-concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ A pipeline defines a type of job. There are following types of pipeline in Radix

### The `build-deploy` pipeline

This is triggered by a commit in GitHub to a branch mapped to an environment. In turn, this causes all components to be rebuilt and a new deployment to be created in the appropriate environment. If many components are built from the same source, then one multi-component image is built for all components. If there are several multi-components in the config, the multi-component images will be indexed.
This is triggered by a commit in GitHub to a branch mapped to an environment. In turn, this causes all components to be rebuilt and a new deployment to be created in the appropriate environment.

![Diagram of the build-deploy pipeline](./pipeline-build-deploy.jpg "The build-deploy pipeline")

Expand Down