Skip to content

Commit 17e35fa

Browse files
authored
Update compat docs for CI and rebuild (#2481)
1 parent 05071d6 commit 17e35fa

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

book/src/framework/compat.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
11
# Compatibility Testing
22

3-
## Prerequisites
3+
## Integrating Compatibility CI
4+
5+
To create CL node compatibility CI in your reporisoty follow these steps:
6+
7+
1. Setup role to pull CL and JD [images](https://github.com/smartcontractkit/infra/tree/master/accounts/production/global/aws/iam/roles/gha-smartcontractkit).
8+
Add it to your secrets:
9+
```bash
10+
gh secret set MY_SECRET
11+
# enter your secret, it should be something like:
12+
# arn:aws:iam::<prod_registry>:role/gha-smartcontractkit-public-ecr <- name for your role
13+
```
14+
15+
2. Copy this [pipeline](https://github.com/smartcontractkit/chainlink/blob/sot-upgrade-workflow/.github/workflows/devenv-compat.yml) to your repository
16+
17+
3. Add nightly pipeline for your product, see `df1-compat` [example](https://github.com/smartcontractkit/chainlink/blob/sot-upgrade-workflow/.github/workflows/devenv-nightly-compat.yml#L42)
18+
19+
## Usage
20+
21+
### Prerequisites
422

523
Authorize in our SDLC ECR registry first. Get the creds and run
624

725
```bash
826
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin <sdlc_ecr_registry>
927
```
1028

11-
## Testing Upgrade Sequence
29+
If you don't have `ctf` CLI, download it [here](https://smartcontractkit.github.io/chainlink-testing-framework/framework/getting_started.html)
30+
31+
### Testing Upgrade Sequence Locally
1232

1333
We have a simple tool to check compatibility for CL node clusters. The example command will filter and sort the available tags, rollback and install the oldest version, and then begin performing automatic upgrades to verify that each subsequent version remains compatible with the previous one.
1434

@@ -44,7 +64,7 @@ ctf compat backward \
4464

4565
In case you have multiple DONs in your product and names of nodes are different please use `--node-name-template custom-cl-node-%d` option
4666

47-
## Modelling Node Operators Cluster (WIP)
67+
### Modelling Node Operators Cluster (WIP)
4868

4969
It is possible to fetch versions node operators are currently running and model DON upgrade sequence locally. When `product` is specified, `compat` will fetch the current versions from the RANE SOT data source and model the upgrade sequence for versions found on real DONs up to the latest one, each node one at a time.
5070

0 commit comments

Comments
 (0)