declarative devnet deployments with kubernetes PT.2

DaMandal0rian commented 2 months ago

Type

enhancement

Description

continues on #307 by adding domain node operators
Added Kubernetes configurations for bootstrap domain and domain operator nodes in a devnet environment.
Introduced ConfigMaps, Services, StatefulSets, PVCs, and StorageClasses for both node types.
Configured networking, storage, and security settings for robust and scalable node deployment.

Changes walkthrough

Relevant files

Configuration changes

11 files

archival-node-configmap.yaml `Add ConfigMap for Bootstrap Archival Node` kubernetes/devnet/base/bootstrap-domain-node/archival-node-configmap.yaml Created a new ConfigMap for bootstrap archival node configuration. Includes various network and node identifiers and Docker tag.	+17/-0
archival-node-service.yaml `Define Service for Bootstrap Domain Nodes` kubernetes/devnet/base/bootstrap-domain-node/archival-node-service.yaml Introduced a new Service definition for bootstrap domain nodes. Configured multiple TCP and UDP ports for different services.	+47/-0
archival-node.yaml `Setup StatefulSet for Bootstrap Domain Node` kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml Added a StatefulSet for the bootstrap domain node with detailed container specs. Configured security, networking, and probes.	+280/-0
pvc.yaml `Add PVC for Bootstrap Archival Node` kubernetes/devnet/base/bootstrap-domain-node/pvc.yaml Created a PersistentVolumeClaim for bootstrap archival node. Specifies storage class and size.	+12/-0
storageclass-aws.yaml `Define AWS EBS StorageClass for Bootstrap Node` kubernetes/devnet/base/bootstrap-domain-node/storageclass-aws.yaml Introduced a new AWS EBS StorageClass. Configured with gp3 type and ext4 file system.	+13/-0
archival-node-configmap.yaml `Add ConfigMap for Domain Node` kubernetes/devnet/base/domain-node/archival-node-configmap.yaml Created a new ConfigMap for domain node configuration. Includes network and node identifiers and Docker tag.	+17/-0
archival-node.yaml `Setup StatefulSet for Domain Node` kubernetes/devnet/base/domain-node/archival-node.yaml Added a StatefulSet for domain nodes with detailed container specs. Configured security, networking, and probes.	+162/-0
ingress.yaml `Configure Ingress for Domain Node` kubernetes/devnet/base/domain-node/ingress.yaml Introduced an Ingress configuration for domain nodes. Configured SSL redirection and rewrite rules.	+25/-0
pvc.yaml `Add PVC for Domain Node` kubernetes/devnet/base/domain-node/pvc.yaml Created a PersistentVolumeClaim for domain nodes. Specifies storage class and size.	+12/-0
service.yaml `Define Service for Domain Nodes` kubernetes/devnet/base/domain-node/service.yaml Defined a new Service for domain nodes. Configured multiple TCP and UDP ports for different services.	+36/-0
storageclass-aws.yaml `Define AWS EBS StorageClass for Domain Node` kubernetes/devnet/base/domain-node/storageclass-aws.yaml Introduced a new AWS EBS StorageClass. Configured with gp3 type and ext4 file system.	+13/-0

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 2 months ago

PR Description updated to latest commit (https://github.com/subspace/infra/commit/e2cae668418131bd4db2df543de00247e1602838)

github-actions[bot] commented 2 months ago

PR Review

⏱️ Estimated effort to review [1-5]	4, due to the extensive changes across multiple Kubernetes configuration files, including ConfigMaps, Services, StatefulSets, and StorageClasses. The PR involves complex configurations that require careful review to ensure they meet the intended deployment specifications and security standards.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: The service name in the `archival-node-service.yaml` file is misspelled as `boostrap-domain-node-service` instead of `bootstrap-domain-node-service`. This could lead to issues when other resources try to reference this service.
🔍 Possible issues	Configuration Consistency: The `metadata.namespace` for the `domain-node-pvc.yaml` is set to `default`, which might not be consistent with other configurations that specify a different namespace, such as `bootstrap-domain`. This inconsistency can lead to deployment issues in a multi-namespace environment.
🔒 Security concerns	No

Code feedback:

relevant file	kubernetes/devnet/base/bootstrap-domain-node/archival-node-service.yaml
suggestion	Correct the typo in the service name from `boostrap-domain-node-service` to `bootstrap-domain-node-service`. This change is important to ensure that other resources can correctly reference this service. [important]
relevant line	name: boostrap-domain-node-service

relevant file	kubernetes/devnet/base/domain-node/pvc.yaml
suggestion	Ensure the namespace for the `domain-node-pvc` matches the intended deployment environment or is consistent with other PVC configurations to avoid deployment issues in a multi-namespace setup. Consider setting it explicitly to a specific namespace used by other domain node resources. [important]
relevant line	namespace: default # Ensure this is set to the namespace where your workload runs

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.

github-actions[bot] commented 2 months ago

PR Code Suggestions

Category	Suggestions
Bug	Correct the typo in the service name for consistency and correct referencing. ___ Correct the typo in the service name from 'boostrap-domain-node-service' to 'bootstrap-domain-node-service' to match the intended naming convention and ensure consistency across configurations. [kubernetes/devnet/base/bootstrap-domain-node/archival-node-service.yaml [4]](https://github.com/subspace/infra/pull/308/files#diff-426bba379c71565d075374f030fd4551d5fc2284ac912c4e3860cc4ba36de050R4-R4) ```diff -name: boostrap-domain-node-service +name: bootstrap-domain-node-service ```
Bug	Correct the environment variable placeholder syntax for proper substitution. ___ Replace the placeholder `${DSN_NODE_KEY}` with the correct syntax `$(DSN_NODE_KEY)` to ensure proper value substitution from the environment variables in Kubernetes. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [128]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R128-R128) ```diff -- ${DSN_NODE_KEY} +- $(DSN_NODE_KEY) ```
Enhancement	Specify `nodeName` for targeted pod scheduling on a specific node. ___ Ensure that the `nodeName` field is specified under `affinity.nodeAffinity` to bind the StatefulSet to a specific node, enhancing the control over where pods are scheduled. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [23-30]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R23-R30) ```diff nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - - key: bootstrap-domain-node + - key: kubernetes.io/hostname operator: In values: - - "1" + - specific-node-name ```
Best practice	Define resource limits for the container to manage resource usage effectively. ___ Add resource limits for the container 'dsn-bootstrap-node' to prevent potential resource exhaustion, ensuring better resource management and stability. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [184-186]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R184-R186) ```diff resources: requests: cpu: "500m" memory: "1Gi" + limits: + cpu: "1" + memory: "2Gi" ```
	Change the namespace to a non-default one for better resource management. ___ Consider specifying a more appropriate namespace instead of using the default namespace for better isolation and management of Kubernetes resources. [kubernetes/devnet/base/domain-node/ingress.yaml [5]](https://github.com/subspace/infra/pull/308/files#diff-ec1b84f6931fd043490fc82c069fed9898de3233a036faa4787f034a06dbe5f2R5-R5) ```diff -namespace: default +namespace: devnet ```
	Add explicit `targetPort` definitions where missing. ___ For the service ports that do not specify a `targetPort`, explicitly define it even if it is the same as `port` for clarity and future-proofing the configuration. [kubernetes/devnet/base/domain-node/service.yaml [27]](https://github.com/subspace/infra/pull/308/files#diff-44fd9c98759e9f06238161df924995e02b0e6ac7c0b87e1fba0f06ec4f4296e7R27-R27) ```diff - name: operator_p2p protocol: TCP port: 30334 + targetPort: 30334 ```
Maintainability	Remove duplicate command-line arguments to avoid configuration errors. ___ Remove redundant command-line arguments related to state and block pruning since they are specified multiple times, which could lead to confusion and misconfiguration. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [253-255]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R253-R255) ```diff - "--state-pruning" - "archive" -- "--blocks-pruning" -- "archive" ```
	Clarify or remove the namespace comment for better code clarity. ___ It's recommended to specify a more descriptive comment regarding the namespace requirement or to remove the comment if the namespace is self-explanatory. [kubernetes/devnet/base/domain-node/pvc.yaml [5]](https://github.com/subspace/infra/pull/308/files#diff-4349b7aa8b378520c50fd22a4bcadbdb05cbbcd54896b45783d8a54a626dad40R5-R5) ```diff -namespace: default # Ensure this is set to the namespace where your workload runs +namespace: default ```
	Verify or document the setup for `tls-secret`. ___ Ensure that the `tls-secret` mentioned in the comments is created or managed properly, or provide documentation on how to set it up if it's not part of this configuration. [kubernetes/devnet/base/domain-node/ingress.yaml [14]](https://github.com/subspace/infra/pull/308/files#diff-ec1b84f6931fd043490fc82c069fed9898de3233a036faa4787f034a06dbe5f2R14-R14) ```diff -secretName: tls-secret # Ensure you have this TLS secret in your namespace +secretName: tls-secret ```
Performance	Remove the `debug` mount option to enhance performance. ___ Consider removing the `debug` option from `mountOptions` unless specifically needed for troubleshooting, to avoid unnecessary performance overhead. [kubernetes/devnet/base/domain-node/storageclass-aws.yaml [12]](https://github.com/subspace/infra/pull/308/files#diff-0d90bce06ff6d46ba8f78898a06c50168db0ab30e1203a7f489f8db6bd13a274R12-R12) ```diff -mountOptions: - - debug +mountOptions: [] ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

Category	Suggestions
Bug	Correct the typo in the service name for consistency and correct referencing. ___ Correct the typo in the service name from 'boostrap-domain-node-service' to 'bootstrap-domain-node-service' to match the intended naming convention and ensure consistency across configurations. [kubernetes/devnet/base/bootstrap-domain-node/archival-node-service.yaml [4]](https://github.com/subspace/infra/pull/308/files#diff-426bba379c71565d075374f030fd4551d5fc2284ac912c4e3860cc4ba36de050R4-R4) ```diff -name: boostrap-domain-node-service +name: bootstrap-domain-node-service ```
Bug	Correct the environment variable placeholder syntax for proper substitution. ___ Replace the placeholder `${DSN_NODE_KEY}` with the correct syntax `$(DSN_NODE_KEY)` to ensure proper value substitution from the environment variables in Kubernetes. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [128]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R128-R128) ```diff -- ${DSN_NODE_KEY} +- $(DSN_NODE_KEY) ```
Enhancement	Specify `nodeName` for targeted pod scheduling on a specific node. ___ Ensure that the `nodeName` field is specified under `affinity.nodeAffinity` to bind the StatefulSet to a specific node, enhancing the control over where pods are scheduled. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [23-30]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R23-R30) ```diff nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchExpressions: - - key: bootstrap-domain-node + - key: kubernetes.io/hostname operator: In values: - - "1" + - specific-node-name ```
Best practice	Define resource limits for the container to manage resource usage effectively. ___ Add resource limits for the container 'dsn-bootstrap-node' to prevent potential resource exhaustion, ensuring better resource management and stability. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [184-186]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R184-R186) ```diff resources: requests: cpu: "500m" memory: "1Gi" + limits: + cpu: "1" + memory: "2Gi" ```
	Change the namespace to a non-default one for better resource management. ___ Consider specifying a more appropriate namespace instead of using the default namespace for better isolation and management of Kubernetes resources. [kubernetes/devnet/base/domain-node/ingress.yaml [5]](https://github.com/subspace/infra/pull/308/files#diff-ec1b84f6931fd043490fc82c069fed9898de3233a036faa4787f034a06dbe5f2R5-R5) ```diff -namespace: default +namespace: devnet ```
	Add explicit `targetPort` definitions where missing. ___ For the service ports that do not specify a `targetPort`, explicitly define it even if it is the same as `port` for clarity and future-proofing the configuration. [kubernetes/devnet/base/domain-node/service.yaml [27]](https://github.com/subspace/infra/pull/308/files#diff-44fd9c98759e9f06238161df924995e02b0e6ac7c0b87e1fba0f06ec4f4296e7R27-R27) ```diff - name: operator_p2p protocol: TCP port: 30334 + targetPort: 30334 ```
Maintainability	Remove duplicate command-line arguments to avoid configuration errors. ___ Remove redundant command-line arguments related to state and block pruning since they are specified multiple times, which could lead to confusion and misconfiguration. [kubernetes/devnet/base/bootstrap-domain-node/archival-node.yaml [253-255]](https://github.com/subspace/infra/pull/308/files#diff-8f406fa9a22d59707564e2982062351968fd974319d584bd46ffa76d112975a1R253-R255) ```diff - "--state-pruning" - "archive" -- "--blocks-pruning" -- "archive" ```
	Clarify or remove the namespace comment for better code clarity. ___ It's recommended to specify a more descriptive comment regarding the namespace requirement or to remove the comment if the namespace is self-explanatory. [kubernetes/devnet/base/domain-node/pvc.yaml [5]](https://github.com/subspace/infra/pull/308/files#diff-4349b7aa8b378520c50fd22a4bcadbdb05cbbcd54896b45783d8a54a626dad40R5-R5) ```diff -namespace: default # Ensure this is set to the namespace where your workload runs +namespace: default ```
	Verify or document the setup for `tls-secret`. ___ Ensure that the `tls-secret` mentioned in the comments is created or managed properly, or provide documentation on how to set it up if it's not part of this configuration. [kubernetes/devnet/base/domain-node/ingress.yaml [14]](https://github.com/subspace/infra/pull/308/files#diff-ec1b84f6931fd043490fc82c069fed9898de3233a036faa4787f034a06dbe5f2R14-R14) ```diff -secretName: tls-secret # Ensure you have this TLS secret in your namespace +secretName: tls-secret ```
Performance	Remove the `debug` mount option to enhance performance. ___ Consider removing the `debug` option from `mountOptions` unless specifically needed for troubleshooting, to avoid unnecessary performance overhead. [kubernetes/devnet/base/domain-node/storageclass-aws.yaml [12]](https://github.com/subspace/infra/pull/308/files#diff-0d90bce06ff6d46ba8f78898a06c50168db0ab30e1203a7f489f8db6bd13a274R12-R12) ```diff -mountOptions: - - debug +mountOptions: [] ```

subspace / infra