Skip to content

Commit

Permalink
Merge pull request #5794 from NomicFoundation/ignition/global-params-…
Browse files Browse the repository at this point in the history
…docs

Add global parameters to docs
  • Loading branch information
zoeyTM authored Oct 8, 2024
2 parents 0883d8b + 1bcae2d commit 5948257
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/src/content/ignition/docs/guides/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ An example file could be called `./ignition/parameters.json` and contain the fol
}
```

:::tip

`JSON5` format is also supported for parameter files!

:::

This makes the `name` parameter for the `Apollo` module be `"Saturn V"`.

To execute a deployment using parameters, you need to use the `--parameters` argument, like this:
Expand Down Expand Up @@ -74,6 +80,21 @@ To pass a `bigint` as a Module parameter, you can encode it as a string. Any str
}
```

You can also define global parameters that will be available to all modules. To do this, define a `$global` key in the parameters file:

```json
{
"$global": {
"shouldBeAllowed": true
},
"MyModule": {
"shouldBeAllowed": false
}
}
```

In this example, the `shouldBeAllowed` parameter will be `true` for all modules except `MyModule`, where it will be `false`. Global parameters can be accessed in the same way as module parameters.

## Inspecting an existing deployment

To get a list of all the deployment IDs that exist in the current project, run:
Expand Down

0 comments on commit 5948257

Please sign in to comment.