Skip to content

Commit 5eda647

Browse files
committed
fix(docs): remove irrelevant internal guides
1 parent 260752f commit 5eda647

File tree

2 files changed

+1
-86
lines changed

2 files changed

+1
-86
lines changed

docs/developer-guides/dependencies.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,3 @@ sidechains-stack attach --address <ip(default localhost)> --port 8081
8484
```
8585
You can also access the swagger UI through the browser e.g. by visiting
8686
`127.0.0.1:8081`
87-
88-
## Forwarding Ports using Kubernetes
89-
90-
Running the dependencies locally can often be avoided by forwarding ports from the pods deployed to our devnet.
91-
This can be done by running:
92-
```sh
93-
kubectl port-forward devnet-services -n sc 1337 1337
94-
kubectl port-forward devnet-services -n sc 1442 1442
95-
```
96-
to expose Ogmios and Kupo ports from the devnet-services pod.
97-
98-
```sh
99-
kubectl port-forward dave -n sc 5432 5432
100-
```
101-
to expose Postgres port from the dave pod.

docs/developer-guides/getting-started.md

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,14 @@ environment.
1818
use it to enter the project shell, preferably with [`direnv`](#direnv-support),
1919
but `nix develop` will also work.
2020

21-
In order for nix to access our private repositories, it needs to be aware of a
22-
github token. Create a `.netrc` file in your home directory with the following
23-
content:
24-
```
25-
machine github.com
26-
login <GITHUB_LOGIN>
27-
password <GITHUB_TOKEN>
28-
29-
machine api.github.com
30-
login <GITHUB_LOGIN>
31-
password <GITHUB_TOKEN>
32-
```
33-
34-
`GITHUB_TOKEN` should have following permissions:
35-
- repo (full)
36-
- read:org
37-
3821
It is recommended to add at least the following snippet to your
3922
`/etc/nix/nix.conf` for all methods:
4023
```
4124
extra-experimental-features = nix-command flakes
42-
netrc-file = /home/<USERNAME>/.netrc
4325
```
4426

4527

46-
After the token is setup, move to this project's directory and allow direnv to
47-
read the `.envrc` file:
28+
Move to the project's directory and allow direnv to read the `.envrc` file:
4829
```
4930
# if you need to enable direnv on the project for the first time
5031
direnv allow
@@ -68,54 +49,3 @@ will also load the environmental variables used in development of this project.
6849
It is highly recommended that you use this route not only for the
6950
above-mentioned benefits, but because it will allow your shell to survive a
7051
garbage collection, making entering it super quick after the initial build.
71-
72-
## AWS Account
73-
74-
To work with the Kubernetes cluster hosting developers environment,
75-
a user created in AWS Account 689191102645 is required.
76-
Terraform files controlling the environment are placed in the **sidechains-infra-priv**
77-
repository. To get a user, create a PR to the **master** branch, it should contain
78-
the entry with GPG public key and group assignment.
79-
See https://github.com/input-output-hk/sidechains-infra-priv/pull/36 for reference.
80-
When your PR is merged and terraform applied, SREs should give you the
81-
first password for your user.
82-
Log in https://eu-central-1.console.aws.amazon.com/console/home?region=eu-central-1#
83-
and change it.
84-
85-
## AWS and EKS
86-
87-
Setup AWS and EKS configuration files.
88-
89-
1. Log in to AWS web console, from "user menu" go to "Security credentials",
90-
and create Access Keys, then setup ~/.aws/credentials file using **Long-term credentials**
91-
tab of this guide: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html.
92-
2. kubectl config: https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html
93-
```
94-
aws eks update-kubeconfig --region eu-central-1 --name iog-sidechain-substrate-kubernetes
95-
# test
96-
kubectl get pods -n sc
97-
```
98-
3. To log in into ECR, to pull or push images hosted there, run following command:
99-
```
100-
aws ecr get-login-password --region eu-central-1 | docker login --username AWS --password-stdin 689191102645.dkr.ecr.eu-central-1.amazonaws.com
101-
```
102-
103-
## Testing locally
104-
105-
To be able to test your changes locally, you need some number of nodes running locally, depending on how much functionality is tested. One node for a smoke test, checking if application reads configuration properly. Two nodes are required for block production.
106-
107-
Command below show how to run a node locally:
108-
```
109-
./target/debug/sidechains-substrate-node --alice --base-path .run/data/alice --chain local --validator --node-key 0000000000000000000000000000000000000000000000000000000000000001 --port 30033 --rpc-port 3333 --unsafe-rpc-external --rpc-cors=all --state-pruning archive --blocks-pruning archive
110-
```
111-
`--alice` is one of special flags, that adhere to keys we usually use on devnet.
112-
Others are bob, charlie, dave, eve, ferdie and greg.
113-
`--chain local` makes node use the Local Testnet chain specification (chain_spec.rs file).
114-
`--node-key` please use from 1 to N with 0s prefix.
115-
`--state-pruning archive --blocks-pruning archive` are important, to test all endpoints we need
116-
archive nodes.
117-
118-
Nodes read configuration from environment. `.envrc` file in this repository should be in-sync
119-
with partner chain used by devnet, which usually is an initialized and running chain. Devnet partner chains can sometimes be used to test committee-rotation. For more extensive testing one should [create their own partner chain on the main chain](./user-guides/chain-builder.md). Then [run the required dependencies](dependencies.md) and test the system.
120-
121-
Please update partner-chains-smart-contracts revision in flake.nix, if your changes need a different version of partner-chains-smart-contracts than currently committed.

0 commit comments

Comments
 (0)