Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that spawning network in k8s should be in default namespace #1439

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,18 @@ Then you can spawn the network by running the following command:
❯ ./zombienet-macos spawn --provider native examples/0001-small-network.toml
```

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

Note that the command expects two binaries `polkadot` and `adder-collator` to be installed on your system. See further down for how to get them.

You can follow the output of the `steps` to spawn the network and once the network is launched a
Expand Down
12 changes: 12 additions & 0 deletions docs/src/cli/spawn.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ Then you can spawn the network by running the following command:
./zombienet-macos spawn examples/0001-small-network.toml
```

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

You can follow the output of the `steps` to spawn the network and once the network is launched a message with the `node`s information like this one is show

```bash
Expand Down
12 changes: 12 additions & 0 deletions docs/src/cli/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ Those assertions should be defined in a _feature test_, and the `dsl` and format

The following is a small example to spawn a network (using the previous `simple network definition`) and assert that:

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

- Both `nodes` are running
- The defined `parachain` is registered
- The defined `parachain` is producing blocks and produced at least 10 within 200 seconds.
Expand Down
12 changes: 12 additions & 0 deletions docs/src/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ Zombienet was designed to be a flexible and easy to use tool, allowing users to

In this guide we will go through simple use cases as well as more complex ones, describing the trade-offs made and the _current_ constraints for both network configurations and test specifications.

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

---

### Example 0 - Different configuration file types (2 validators)
Expand Down
12 changes: 12 additions & 0 deletions javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,18 @@ Then you can spawn the network by running the following command:
❯ ./zombienet-macos spawn --provider native examples/0001-small-network.toml
```

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

Note that the command expects two binaries `polkadot` and `adder-collator` to be installed on your system. See further down for how to get them.

You can follow the output of the `steps` to spawn the network and once the network is launched a
Expand Down
12 changes: 12 additions & 0 deletions javascript/packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,18 @@ Then you can spawn the network by running the following command:
❯ ./zombienet-macos spawn --provider native examples/0001-small-network.toml
```

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

Note that the command expects two binaries `polkadot` and `adder-collator` to be installed on your system. See further down for how to get them.

You can follow the output of the `steps` to spawn the network and once the network is launched a
Expand Down
12 changes: 12 additions & 0 deletions javascript/packages/orchestrator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,18 @@ Then you can spawn the network by running the following command:
❯ ./zombienet-macos spawn --provider native examples/0001-small-network.toml
```

**Note:** before spawning network one needs to verify that `kubectl`'s namespace is set to `default`
```bash
❯ kubectl config get-contexts

CURRENT NAME CLUSTER AUTHINFO NAMESPACE
* docker-desktop docker-desktop docker-desktop default

# if not then set it to default value

❯ kubectl config set-context --current --namespace='default'
```

Note that the command expects two binaries `polkadot` and `adder-collator` to be installed on your system. See further down for how to get them.

You can follow the output of the `steps` to spawn the network and once the network is launched a
Expand Down
1 change: 1 addition & 0 deletions javascript/words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ anguage
asgn
astar
auths
AUTHINFO
autoremove
availables
aventus
Expand Down
Loading