You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: book/src/framework/compat.md
+8-22Lines changed: 8 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Compatibility testing verifies that your product remains functional when Chainli
10
10
3. Boot environment with the oldest image → run tests (baseline)
11
11
4. For each next version:
12
12
a. Pull the new Docker image
13
-
b. Upgrade N nodes (stop container, swap image, restart — DB volumes preserved)
13
+
b. Upgrade N nodes (stop container, swap image, restart — node DB volumes preserved)
14
14
c. Run tests again (mixed-version cluster)
15
15
5. Repeat until the latest version is fully deployed and tested
16
16
```
@@ -37,19 +37,19 @@ Add the following secrets to your repository (`Settings → Secrets and variable
37
37
|---|---|---|
38
38
|`PRODUCT_IAM_ROLE`| ARN of the IAM role that grants ECR pull access. Name it with your product name, for example CCV_IAM_ROLE |`arn:aws:iam::<account_id>:role/gha-smartcontractkit-<repo>`|
39
39
|`JD_REGISTRY`| Private ECR registry ID for JD images |`<production_ecr_registry_number>.dkr.ecr.us-west-2.amazonaws.com`|
40
-
|`JD_IMAGE`| Full JD image reference (used by your environment config) |`<production_ecr_registry_number>.dkr.ecr.us-west-2.amazonaws.com/job-distributor:0.12.7`|
40
+
|`JD_IMAGE`| Full JD image reference (used by your environment config) |`<production_ecr_registry_number>.dkr.ecr.us-west-2.amazonaws.com/job-distributor:0.22.1`|
41
41
42
42
Using the GitHub CLI:
43
43
44
44
```bash
45
-
gh secret setCCV_IAM_ROLE# paste the IAM role ARN
45
+
gh secret setPRODUCT_IAM_ROLE# paste the IAM role ARN
46
46
gh secret set JD_REGISTRY # paste the JD registry URL
47
47
gh secret set JD_IMAGE # paste the JD image reference
48
48
```
49
49
50
50
### Step 3 — Copy the Compat Pipeline
51
51
52
-
Copy `devenv-compat.yml` from [chainlink/sot-upgrade-workflow](https://github.com/smartcontractkit/chainlink/blob/sot-upgrade-workflow/.github/workflows/devenv-compat.yml) into your repository at `.github/workflows/devenv-compat.yml`.
52
+
Copy `devenv-compat.yml` from [chainlink](https://github.com/smartcontractkit/chainlink/blob/develop/.github/workflows/devenv-compat.yml) into your repository at `.github/workflows/devenv-compat.yml`.
53
53
54
54
The workflow performs the following on each run:
55
55
@@ -62,14 +62,14 @@ The workflow performs the following on each run:
62
62
- name: Authenticate to AWS ECR
63
63
uses: ./.github/actions/aws-ecr-auth
64
64
with:
65
-
role-to-assume: ${{ secrets.CCV_IAM_ROLE }}
65
+
role-to-assume: ${{ secrets.PRODUCT_IAM_ROLE }}
66
66
aws-region: us-east-1
67
67
registry-type: public
68
68
69
69
- name: Authenticate to AWS ECR (JD)
70
70
uses: ./.github/actions/aws-ecr-auth
71
71
with:
72
-
role-to-assume: ${{ secrets.CCV_IAM_ROLE }}
72
+
role-to-assume: ${{ secrets.PRODUCT_IAM_ROLE }}
73
73
aws-region: us-west-2
74
74
registry-type: private
75
75
registries: ${{ secrets.JD_REGISTRY }}
@@ -90,23 +90,9 @@ The workflow performs the following on each run:
90
90
91
91
### Step 4 — Add a Nightly Trigger
92
92
93
-
Compatibility tests are typically run on a nightly schedule rather than on every PR. Add a nightly workflow (or a separate trigger in the same file) that points to your product configuration:
93
+
Compatibility tests are typically run on a nightly schedule rather than on every PR. Add a nightly workflow that points to your product configuration:
94
94
95
-
```yaml
96
-
# .github/workflows/devenv-nightly-compat.yml
97
-
on:
98
-
schedule:
99
-
- cron: '0 6 * * *' # 06:00 UTC every night, after the nightly CL image is built
100
-
workflow_dispatch: # allow manual runs
101
-
102
-
jobs:
103
-
compat:
104
-
uses: ./.github/workflows/devenv-compat.yml
105
-
secrets: inherit
106
-
with:
107
-
```
108
-
109
-
See the [chainlink nightly example](https://github.com/smartcontractkit/chainlink/blob/sot-upgrade-workflow/.github/workflows/devenv-nightly-compat.yml#L42) for a complete reference.
95
+
See the [chainlink nightly example](https://github.com/smartcontractkit/chainlink/blob/develop/.github/workflows/devenv-nightly-compat.yml#L42) for a complete reference.
0 commit comments