Known Test Plan configuration
A Known Test Plan is a reference to a Test Plan in GitHub, stored by the Orchestrator along with settings that control who can trigger it and where it runs. Owners and Admins edit these settings from the Edit test plan section of the Known Test Plan’s page in the Orchestrator UI.
Settings
| Setting | Admin only | Description |
|---|---|---|
| Name | Unique name for the Known Test Plan. | |
| Description | Optional description. | |
| Org, Repo, and Path | Location of the Test Plan file in GitHub. Each location can only be registered once. | |
| Triggers | Unrestricted, or Restricted to owners and trigger users. | |
| Automated triggers | Allowed, or Disabled to prevent the Known Test Plan from being run from CI. | |
| Trigger users | Users who can trigger the Known Test Plan when triggers are restricted. One email address per line. | |
| Namespace write access | Whether Scenarios can write to Kubernetes resources in their namespace. Pool default uses the pool’s setting. | |
| Node label weights | How to split the nodes of a Dedicated Cluster between labels. One label=weight per line. See below. | |
| Owners | Yes | Users who can edit the Known Test Plan and cancel its runs. One email address per line. |
| Pinned workload pool | Yes | The Workload Pool to run in. Not pinned uses the default pool. |
| Dedicated cluster | Yes | Required claims a whole cluster for each run. The pinned pool must support Dedicated Clusters. |
A user can be an owner or a trigger user, but not both.
Node label weights
Node label weights split the nodes of a Dedicated Cluster between labels. Each label receives a share of the cluster’s nodes equal to its weight divided by the total of all weights, so only the ratio between the weights matters, not their absolute values.
Node label weights:
- Require the Known Test Plan to be pinned to a pool and to require a Dedicated Cluster
- Use Kubernetes label value syntax for each label, and each label must be unique
- Must include at least one non-zero weight
Examples
The following examples split a Dedicated Cluster with 6 nodes between a router and its subgraphs.
Weights of 1 and 1 split the nodes evenly, giving each label 3 nodes:
router=1
subgraphs=1
Weights of 2 and 2 have the same ratio as 1 and 1, so they produce exactly the same even
split of 3 nodes each:
router=2
subgraphs=2
To give a third of the nodes to the subgraphs and two thirds to the router, use weights of 1 and
2. This gives the subgraphs label 2 nodes and the router label 4 nodes:
router=2
subgraphs=1
When the nodes can’t be split exactly, each label’s share is rounded down and the remaining nodes
are handed out one at a time to whichever label currently has the fewest nodes. For example, the
same 2 and 1 weights on a 7 node cluster give the router label 4 nodes and the subgraphs
label 3 nodes.
Selecting labelled nodes
Each node is labelled rtf.io/node-allocation=<label>. Environment services select the nodes for a
label using the rtf.io/required-node-label-key and rtf.io/required-node-label-value
service labels:
services:
router:
image: ghcr.io/apollographql/router:v2.14.0
labels:
rtf.io/required-node-label-key: "rtf.io/node-allocation"
rtf.io/required-node-label-value: "router"