diff --git a/docs/nx-cloud/features/dynamic-agents.md b/docs/nx-cloud/features/dynamic-agents.md index 43ee22a0b1cd9..05520f920bd82 100644 --- a/docs/nx-cloud/features/dynamic-agents.md +++ b/docs/nx-cloud/features/dynamic-agents.md @@ -10,7 +10,7 @@ By default, when you set up [Nx Agents](/ci/features/distribute-task-execution) ... jobs: - job: main - displayName: Main Job + name: Main Job ... steps: ... @@ -68,7 +68,7 @@ You can then reference your distribution configuration in your CI pipeline confi ... jobs: - job: main - displayName: Main Job + name: Main Job ... steps: ... diff --git a/docs/nx-cloud/reference/assignment-rules.md b/docs/nx-cloud/reference/assignment-rules.md index 5d96816ecae8a..0dcd2feea73b0 100644 --- a/docs/nx-cloud/reference/assignment-rules.md +++ b/docs/nx-cloud/reference/assignment-rules.md @@ -1,24 +1,21 @@ # Assignment Rules (beta) -Assignment rules allow you to control which tasks can run on which agents. Save on agent costs by provisioning different sizes of agents all with the confidence that your tasks will be run on the agents that are best suited for them. You can ensure resource intensive targets like `e2e-ci` and `build` have what they need by using larger agents. Lighter tasks like `lint` and `test` can run on smaller agents. +Assignment rules allow you to control which tasks can run on which agents. Save on agent costs by provisioning different sizes of agents to suite the individual needs of your tasks. You can ensure resource intensive targets like `e2e-ci` and `build` have what they need by using larger agents. Lighter tasks like `lint` and `test` can run on smaller agents. -Assignment rules are defined in your workspaces `distribution-config.yaml` file. This file should be created in the `.nx/workflows` directory of your repository. Note that this means that you must have [dynamic agents](/ci/features/dynamic-agents) also configured in your `distribution-config.yaml` file. +Assignment rules are defined in `yaml` files within your workspace's `.nx/workflows` directory. You can use assignment rules with self-hosted agents or with [dynamic Nx agents](/ci/features/dynamic-agents). Note that additional configuration is required when using self-hosted agents. ## How to Define an Assignment Rule Each assignment rule has one of the following properties that it matches against tasks: `project`, `target`, and/or `configuration`. It also has a list of possible [agent types](/ci/reference/launch-templates) that tasks with the matching properties can run on. Rules are defined in yaml like the following: -```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} -distribute-on: - default: 3 linux-small-js, 2 linux-medium-js, 1 linux-large-js - +```yaml {% fileName=".nx/workflows/assignment-rules.yaml" %} assignment-rules: - project: app1 target: build configuration: production runs-on: - - linux-large-js - linux-medium-js + - linux-large-js ``` The above rule will match any task that has a project named `app1`, a target named `build`, and a configuration named `production`. Any tasks that match this rule will only be allowed to run on agents with the `linux-large-js` and `linux-medium-js` launch templates. @@ -26,58 +23,13 @@ The above rule will match any task that has a project named `app1`, a target nam You can mix and match any of the criteria in an assignment rule provided that you follow the constraints: - At least one of the following properties is defined: `project`, `target`, `configuration`. -- There is at least one [agent type](/ci/reference/launch-templates) specified in the `run-on` field. -- Every changeset in your `distribute-on` field must include at **least one agent** that matches each agent type specified in the run-on field across all assignment rules. For example, if your rules distribute tasks on `linux-small-js`, `linux-medium-js`, and `linux-large-js`, then at least one agent of each type must be available; otherwise, tasks associated with those rules cannot be executed. - -### Invalid Assignment Rules Example +- There is at least one [agent type](/ci/reference/launch-templates) specified in the `runs-on` field. +- Every changeset in your `distribute-on` field must include at **least one agent** that matches each agent type specified in the `runs-on` field across all assignment rules. For example, if your rules distribute tasks on `linux-small-js`, `linux-medium-js`, and `linux-large-js`, then at least one agent of each type must be available; otherwise, tasks associated with those rules cannot be executed. -```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} -distribute-on: - # Invalid changeset that is missing `linux-large-js`. Tasks assigned to large agents won't be able to execute. - small-changeset: 1 linux-small-js, 2 linux-medium-js - medium-changeset: 2 linux-small-js, 2 linux-medium-js, 3 linux-large-js - large-changeset: 3 linux-small-js, 3 linux-medium-js, 4 linux-large-js - -assignment-rules: - # Missing one of `project`, `target`, `configuration` - - runs-on: - - linux-medium-js - - linux-large-js - - # Missing `runs-on` - - target: lint - configuration: production - - # Agent type not found in any of the `distribute-on` changesets - - project: lib1 - target: test - runs-on: - - linux-extra-large-js -``` - -### Valid Assignment Rules Example - -```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} -distribute-on: - default: 3 linux-small-js, 2 linux-medium-js, 1 linux-large-js - -# All rules below are valid assignment rules -assignment-rules: - - project: app1 - runs-on: - - linux-medium-js - - linux-large-js - - - target: lint - configuration: production - runs-on: - - linux-large-js - - - project: lib1 - target: test - runs-on: - - linux-medium-js -``` +{% callout type="note" title="If you are using self-hosted agents, you must define your own agent types" %} +You must define your own agent types and attach them to your self-hosted agents using the `NX_AGENT_LAUNCH_TEMPLATE` environment variable. Ensure that for each `runs-on` field in your assignment rules, you have corresponding agents in your agent pool that have the same agent type. +See below for an [example](#using-assignment-rules-with-selfhosted-agents) of how to define your own agent types when using self-hosted agents. +{% /callout %} ## Assignment Rule Precedence @@ -95,7 +47,7 @@ Having multiple assignment rules means that often rules may overlap or apply to ### Rule Precedence Example -In this example, the task defined below can match multiple assignment rules. However, since the second rule specifies all three properties (`project`, `target`, and `configuration`) rather than just two (`project` and `target`), it takes precedence, and we apply the second rule when distributing the task. +In this example, the task defined below can match multiple assignment rules. However, since the second rule specifies all three properties (`project`, `target`, and `configuration`) rather than just two (`project` and `target`), it takes precedence, and we automatically apply the second rule when distributing the task. ```json {% fileName="A task from your workspace" %} { @@ -106,10 +58,8 @@ In this example, the task defined below can match multiple assignment rules. How ``` ```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} -distribute-on: - default: 10 linux-medium-js, 8 linux-large-js - assignment-rules: + # A task for app1:build:production will use this rule because it is more specific (matches all three properties instead of just two) - project: app1 target: build configuration: production @@ -122,7 +72,110 @@ assignment-rules: - linux-large-js ``` -## Using Assignment Rules in your CI Pipeline +## Using Assignment Rules with Self-Hosted Agents + +A typical `assignment-rules.yaml` file might look like this: + +```yaml {% fileName=".nx/workflows/assignment-rules.yaml" %} +assignment-rules: + - project: app1 + target: build + configuration: production + runs-on: + - linux-medium + - linux-large + + - target: lint + runs-on: + - linux-medium + + - configuration: development + runs-on: + - linux-medium + - linux-large +``` + +Note that the agent types supplied in the `runs-on` property will be used to determine which agents will have rules applied to them. +You can choose to name your agent types anything you want, but they must be set on your agents via the `NX_AGENT_LAUNCH_TEMPLATE` environment variable. + +You can then reference your assignment rules file within your `start-ci-run` command: + +```shell +npx nx-cloud start-ci-run --distribute-on="manual" --assignment-rules=".nx/workflows/assignment-rules.yaml" +``` + +The following is an example of what this looks like within a Github Actions pipeline: + +```yaml {% fileName=".github/workflows/ci.yaml" %} +--- +jobs: + main: + name: Main Job + runs-on: ubuntu-latest + steps: + - ... # setup steps for your main job + + - run: npx nx-cloud start-ci-run --distribute-on="manual" --assignment-rules=".nx/workflows/assignment-rules.yaml" --stop-agents-after="e2e-ci" + + - ... # Nx commands you want to distribute + + medium-agents: + name: Agents ${{ matrix.agent }} + runs-on: + group: medium-agents + strategy: + matrix: + agent: [1, 2, 3] + steps: + - name: Checkout + uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'npm' + + - ... # other setup steps you may need + + - name: Install dependencies + run: npm ci --legacy-peer-deps + + - name: Start Agent ${{ matrix.agent }} + run: npx nx-cloud start-agent + env: + NX_AGENT_NAME: ${{ matrix.agent }} + NX_AGENT_LAUNCH_TEMPLATE: 'linux-medium' # This value needs to match one of the 'runs-on' values defined in the assignment rules + + large-agents: + name: Agents ${{ matrix.agent }} + runs-on: + group: large-agents + strategy: + matrix: + agent: [1, 2, 3] + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'npm' + + - ... # other setup steps you may need + + - name: Install dependencies + run: npm ci --legacy-peer-deps + + - name: Start Agent ${{ matrix.agent }} + run: npx nx-cloud start-agent + env: + NX_AGENT_NAME: ${{ matrix.agent }} + NX_AGENT_LAUNCH_TEMPLATE: 'linux-large' # This value needs to match one of the 'runs-on' values defined in the assignment rules +``` + +## Using Assignment Rules with Dynamic Nx Agents A typical `distribution-config.yaml` file might look like this: @@ -155,10 +208,62 @@ You can then reference your distribution configuration in your CI pipeline confi ... jobs: - job: main - displayName: Main Job + name: Main Job ... steps: ... - run: npx nx-cloud start-ci-run --distribute-on=".nx/workflows/distribution-config.yaml" --stop-agents-after="e2e-ci" - .. ``` + +### More Examples of Assignment Rules with Dynamic Agents + +#### Invalid Assignment Rules Example + +```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} +distribute-on: + # Invalid changeset that is missing `linux-large-js`. Tasks assigned to large agents won't be able to execute. + small-changeset: 1 linux-small-js, 2 linux-medium-js + medium-changeset: 2 linux-small-js, 2 linux-medium-js, 3 linux-large-js + large-changeset: 3 linux-small-js, 3 linux-medium-js, 4 linux-large-js + +assignment-rules: + # Missing one of `project`, `target`, `configuration` + - runs-on: + - linux-medium-js + - linux-large-js + + # Missing `runs-on` + - target: lint + configuration: production + + # Agent type not found in any of the `distribute-on` changesets + - project: lib1 + target: test + runs-on: + - linux-extra-large-js +``` + +#### Valid Assignment Rules Example + +```yaml {% fileName=".nx/workflows/distribution-config.yaml" %} +distribute-on: + default: 3 linux-small-js, 2 linux-medium-js, 1 linux-large-js + +# All rules below are valid assignment rules +assignment-rules: + - project: app1 + runs-on: + - linux-medium-js + - linux-large-js + + - target: lint + configuration: production + runs-on: + - linux-large-js + + - project: lib1 + target: test + runs-on: + - linux-medium-js +```