Skip to content

Commit

Permalink
add deprecation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
skudasov committed Oct 31, 2024
1 parent 2726341 commit 21c0f3b
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 2 deletions.
2 changes: 1 addition & 1 deletion book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
- [Releasing modules](releasing_modules.md)

---
- [Lib (Legacy, *Deprecated*)](lib.md)
- [Lib (*Deprecated*)](lib.md)
- [Blockchain](lib/blockchain.md)
- [Kubernetes](lib/k8s/KUBERNETES.md)
- [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
Expand Down
7 changes: 7 additions & 0 deletions book/src/lib/blockchain.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Blockchain Clients

<div class="warning">

This documentation is deprecated, we are using it in [Chainlink Integration Tests](https://github.com/smartcontractkit/chainlink/tree/develop/integration-tests)

If you want to test our new products use [v2](../framework/overview.md)
</div>

This folder contains the bulk of code that handles integrating with different EVM chains. If you're looking to run tests on a new EVM chain, and are having issues with the default implementation, you've come to the right place.

### Some Terminology
Expand Down
7 changes: 7 additions & 0 deletions book/src/lib/config/config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# TOML Config

<div class="warning">

This documentation is deprecated, we are using it in [Chainlink Integration Tests](https://github.com/smartcontractkit/chainlink/tree/develop/integration-tests)

If you want to test our new products use [v2](../framework/overview.md)
</div>

These basic building blocks can be used to create a TOML config file. For example:

```golang
Expand Down
2 changes: 1 addition & 1 deletion book/src/lib/k8s/KUBERNETES.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Kubernetes


<div class="warning">

Managing k8s is challenging, so we've decided to separate `k8s` deployments here - [CRIB](https://github.com/smartcontractkit/crib)

This documentation is outdated, and we are using it only internally to run our soak tests. For `v2` tests please check [this example](../crib.md) and read [CRIB docs](https://github.com/smartcontractkit/crib)

</div>

We run our software in Kubernetes.
Expand Down
8 changes: 8 additions & 0 deletions book/src/lib/k8s/REMOTE_RUN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
## How to run the same environment deployment inside k8s

<div class="warning">

Managing k8s is challenging, so we've decided to separate `k8s` deployments here - [CRIB](https://github.com/smartcontractkit/crib)

This documentation is outdated, and we are using it only internally to run our soak tests. For `v2` tests please check [this example](../crib.md) and read [CRIB docs](https://github.com/smartcontractkit/crib)
</div>


You can build a `Dockerfile` to run exactly the same environment interactions inside k8s in case you need to run long-running tests
Base image is [here](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/lib/k8s/Dockerfile.base)

Expand Down
8 changes: 8 additions & 0 deletions book/src/lib/k8s/TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# How to create environments

<div class="warning">

Managing k8s is challenging, so we've decided to separate `k8s` deployments here - [CRIB](https://github.com/smartcontractkit/crib)

This documentation is outdated, and we are using it only internally to run our soak tests. For `v2` tests please check [this example](../crib.md) and read [CRIB docs](https://github.com/smartcontractkit/crib)
</div>


- [Getting started](#getting-started)
- [Connect to environment](#connect-to-environment)
- [Creating environments](#creating-environments)
Expand Down

0 comments on commit 21c0f3b

Please sign in to comment.