feat: add a chart for the network mapper #5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| chart-dirs: | ||
| - charts | ||
| remote: origin | ||
| target-branch: main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,38 @@ | ||
| # network-bootstrapper | ||
|
|
||
| Generate node identities, configure consensus, and emit a Besu genesis. | ||
|
|
||
| ## Helm chart | ||
|
|
||
| The helm chart to run this on Kubernetes / OpenShift can be found [here](./charts/network-bootstrapper/README.md) | ||
|
|
||
| ## CLI usage | ||
|
|
||
| ``` | ||
| Usage: network-bootstrapper [options] | ||
|
|
||
| Generate node identities, configure consensus, and emit a Besu genesis. | ||
|
|
||
| Options: | ||
| -v, --validators <count> Number of validator nodes to generate. | ||
| (default: 4) | ||
| -r, --rpc-nodes <count> Number of RPC nodes to generate. (default: 2) | ||
| -a, --allocations <file> Path to a genesis allocations JSON file. | ||
| (default: none) | ||
| -o, --outputType <type> Output target (screen, file, kubernetes). | ||
| (default: "screen") | ||
| --consensus <algorithm> Consensus algorithm (IBFTv2, QBFT). (default: | ||
| QBFT) | ||
| --chain-id <number> Chain ID for the genesis config. (default: | ||
| random between 40000 and 50000) | ||
| --seconds-per-block <number> Block time in seconds. (default: 2) | ||
| --gas-limit <decimal> Block gas limit in decimal form. (default: | ||
| 9007199254740991) | ||
| --gas-price <number> Base gas price (wei). (default: 0) | ||
| --evm-stack-size <number> EVM stack size limit. (default: 2048) | ||
| --contract-size-limit <number> Contract size limit in bytes. (default: | ||
| 2147483647) | ||
| --accept-defaults Accept default values for all prompts when CLI | ||
| flags are omitted. (default: disabled) | ||
| -h, --help display help for command | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # network-bootstrapper | ||
|
|
||
| Generate node identities, configure consensus, and emit a Besu genesis. | ||
|
|
||
| ## Helm chart | ||
|
|
||
| The helm chart to run this on Kubernetes / OpenShift can be found [here](./charts/network-bootstrapper/README.md) | ||
|
|
||
| ## CLI usage |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Patterns to ignore when building packages. | ||
| # This supports shell glob matching, relative path matching, and | ||
| # negation (prefixed with !). Only one pattern per line. | ||
| .DS_Store | ||
| # Common VCS dirs | ||
| .git/ | ||
| .gitignore | ||
| .bzr/ | ||
| .bzrignore | ||
| .hg/ | ||
| .hgignore | ||
| .svn/ | ||
| # Common backup files | ||
| *.swp | ||
| *.bak | ||
| *.tmp | ||
| *.orig | ||
| *~ | ||
| # Various IDEs | ||
| .project | ||
| .idea/ | ||
| *.tmproj | ||
| .vscode/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| apiVersion: v2 | ||
| name: network-bootstrapper | ||
| description: A Helm chart for Kubernetes | ||
| type: application | ||
| version: 0.1.0 | ||
| appVersion: "0.1.0" | ||
| maintainers: | ||
| - name: SettleMint | ||
| email: support@settlemint.com | ||
| url: https://settlemint.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # network-bootstrapper | ||
|
|
||
|    | ||
|
|
||
| A Helm chart for Kubernetes | ||
|
|
||
| ## Maintainers | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | SettleMint | <support@settlemint.com> | <https://settlemint.com> | | ||
|
|
||
| ## Values | ||
|
|
||
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | affinity | object | `{}` | Affinity and anti-affinity rules influencing pod placement. | | ||
| | fullnameOverride | string | `""` | Fully qualified name override for resources created by this release. | | ||
| | image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/settlemint/network-bootstrapper","tag":""}` | Container image settings for the network bootstrapper workload. See https://kubernetes.io/docs/concepts/containers/images/ for background. | | ||
| | image.pullPolicy | string | `"IfNotPresent"` | Image pull policy controlling when Kubernetes re-fetches the image layer manifest. | | ||
| | image.repository | string | `"ghcr.io/settlemint/network-bootstrapper"` | OCI repository hosting the network bootstrapper image. | | ||
| | image.tag | string | `""` | Image tag override. Defaults to the chart's `.appVersion` when left empty. | | ||
| | imagePullSecrets | list | `[]` | Image pull secrets enabling access to private registries. See https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ for usage. | | ||
| | nameOverride | string | `""` | Short name override applied to chart-scoped resource names. | | ||
| | nodeSelector | object | `{}` | Node selector constraints for scheduling the bootstrapper pod. | | ||
| | podAnnotations | object | `{}` | Pod-level annotations merged onto the generated pod template metadata. See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/. | | ||
| | podLabels | object | `{}` | Pod-level labels applied to the pod template metadata. See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/. | | ||
| | podSecurityContext | object | `{}` | Pod-level security context applied to all containers in the pod. | | ||
| | rbac | object | `{"create":true}` | RBAC resources granting ConfigMap access for Kubernetes output workflows. | | ||
| | rbac.create | bool | `true` | Whether to create Role and RoleBinding objects targeting the service account. | | ||
| | resources | object | `{}` | Resource requests and limits for the bootstrapper container. | | ||
| | securityContext | object | `{}` | Container security context applied to the bootstrapper container. | | ||
| | serviceAccount | object | `{"annotations":{},"automount":true,"create":true,"name":""}` | Service account configuration for the bootstrapper pod. See https://kubernetes.io/docs/concepts/security/service-accounts/ for details. | | ||
| | serviceAccount.annotations | object | `{}` | Additional metadata annotations applied to the service account object. | | ||
| | serviceAccount.automount | bool | `true` | Automatically mount the service account token into the pod. | | ||
| | serviceAccount.create | bool | `true` | Whether to create a service account automatically. | | ||
| | serviceAccount.name | string | `""` | Existing service account name to use instead of one generated by the chart. If unset and `serviceAccount.create` is true, a name is derived from the chart fullname. | | ||
| | settings | object | `{"allocations":null,"chainId":null,"consensus":null,"contractSizeLimit":null,"evmStackSize":null,"gasLimit":null,"gasPrice":null,"outputType":"kubernetes","rpcNodes":null,"secondsPerBlock":null,"validators":null}` | Network bootstrapper CLI settings translated into command-line flags. | | ||
| | settings.allocations | string | `nil` | Filesystem path, accessible to the job, pointing to a JSON file with initial account allocations. Omit to skip pre-funded accounts. | | ||
| | settings.chainId | int | `nil` | Explicit chain ID applied to the genesis configuration. Defaults to a random value in the 40000-50000 range when omitted. | | ||
| | settings.consensus | string | `nil` | Consensus engine to configure for the network (IBFTv2 or QBFT). Default: "QBFT". | | ||
| | settings.contractSizeLimit | int | `nil` | Contract size limit in bytes enforced by the EVM. Default: 2147483647. | | ||
| | settings.evmStackSize | int | `nil` | Maximum EVM stack size allowed for contract execution. Default: 2048. | | ||
| | settings.gasLimit | int | `nil` | Genesis block gas limit value expressed in decimal. Default: 9007199254740991. | | ||
| | settings.gasPrice | int | `nil` | Base gas price in wei applied to the chain. Default: 0. | | ||
| | settings.outputType | string | `"kubernetes"` | Destination for generated artefacts: `screen` (stdout), `file` (write to volume), or `kubernetes` (persist as Kubernetes secrets/configmaps). Default: "screen". | | ||
| | settings.rpcNodes | int | `nil` | Number of RPC node definitions included in the output topology. Default: 2. | | ||
| | settings.secondsPerBlock | int | `nil` | Target block time in seconds encoded into genesis. Default: 2. | | ||
| | settings.validators | int | `nil` | Number of validator node definitions the bootstrapper generates. Default: 4. | | ||
| | tolerations | list | `[]` | Kubernetes tolerations assigned to the bootstrapper pod. | | ||
| | volumeMounts | list | `[]` | Additional volume mounts added to the bootstrapper container. | | ||
| | volumes | list | `[]` | Additional volumes injected into the deployment pod spec. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| Thanks for installing the network bootstrapper chart! | ||
|
|
||
| {{- $jobName := include "network-bootstrapper.fullname" . -}} | ||
| {{- $namespace := .Release.Namespace -}} | ||
| To generate the network configuration, monitor the job status: | ||
|
|
||
| kubectl -n {{ $namespace }} wait --for=condition=complete job/{{ $jobName }} | ||
|
|
||
| Once the job completes you can review the output: | ||
|
|
||
| kubectl -n {{ $namespace }} logs job/{{ $jobName }} | ||
|
|
||
| If `settings.outputType` is set to `kubernetes`, inspect the generated ConfigMaps and Secrets: | ||
|
|
||
| kubectl -n {{ $namespace }} get configmaps | ||
| kubectl -n {{ $namespace }} get secrets | ||
|
|
||
| Refer to the chart documentation for additional post-processing steps tailored to your deployment. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha): An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.
Source: opengrep