Skip to content

Commit

Permalink
Fix broken links, renumber steps, and remove formatting from headings.
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesgas committed Aug 30, 2024
1 parent 8dcc18b commit cd0d595
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
15 changes: 10 additions & 5 deletions pages/pipelines/rules/manage_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,16 @@ Organization admins can create new rules using the **Rules** page in **Organizat
To create a new rule using the Buildkite UI:

1. Select **Settings** in the global navigation to access the **Organization settings** page.
2. Select **Rules** in the Pipelines section.
3. Select **New Rule**.
4. Under **Rule Type**, select the type of rule you want to create, such as `pipeline.trigger_build.pipeline`.
5. Under **Rule Document**, populate the relevant data. For example, if you're creating a `pipeline.trigger_build.pipeline` rule, you'll need to provide a `source_pipeline_uuid` and a `target_pipeline_uuid`. You can find the UUIDs of your pipelines on their **Settings** page under the **GraphQL API integration** section.
6. Select **Submit**.

1. Select **Rules** in the Pipelines section.

1. Select **New Rule**.

1. Under **Rule Type**, select the type of rule you want to create, such as `pipeline.trigger_build.pipeline`.

1. Under **Rule Document**, populate the relevant data. For example, if you're creating a `pipeline.trigger_build.pipeline` rule, you'll need to provide a `source_pipeline_uuid` and a `target_pipeline_uuid`. You can find the UUIDs of your pipelines on their **Settings** page under the **GraphQL API integration** section.

1. Select **Submit**.

### Using the REST API

Expand Down
8 changes: 4 additions & 4 deletions pages/pipelines/rules/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Rules allow you to customize permissions between Buildkite resources.

Rules express that an action (e.g. triggering a build) is allowed between a source resource (e.g. a pipeline) and a target resource (e.g. another pipeline).
Rules express that an action (for example, triggering a build) is allowed between a source resource (for example, a pipeline) and a target resource (for example, another pipeline).

Rules are used to grant or restrict access between resources that would normally be determined by the default permissions.

## Available rule types

### `pipeline.trigger_build.pipeline`
### pipeline.trigger_build.pipeline

Allows one pipeline to trigger another. This is useful where you want to allow a pipeline to trigger a build in another cluster, or if you want to allow a public pipeline to trigger a private one.

Note that this rule type overrides the usual [trigger step permissions checks](docs/pipelines/trigger-step#permissions) on users and teams.
Note that this rule type overrides the usual [trigger step permissions checks](/docs/pipelines/trigger-step#permissions) on users and teams.

Rule document:

Expand All @@ -37,7 +37,7 @@ Clusters may be used to separate the environments necessary for building and dep

A `pipeline.trigger_build.pipeline` rule would allow a trigger step in the CI pipeline in cluster A to target the CD pipeline in cluster B. This would allow deploys to be triggered upon a successful CI build, while still maintaining the separation of the CI and CD agents in their respective clusters.

### `pipeline.artifacts_read.pipeline`
### pipeline.artifacts_read.pipeline

Allows a source pipeline in one cluster to read artifacts from a target pipeline in another cluster.

Expand Down

0 comments on commit cd0d595

Please sign in to comment.