declarative devnet deployments with kubernetes PT.3

[DaMandal0rian]

Type

Enhancement

---

Description

• continues on declarative devnet deployments with kubernetes PT.2 #308 by adding farmer/archival node
• Added Kubernetes configurations for deploying archival and farmer nodes in a devnet environment.
• Configured StatefulSets, Services, ConfigMaps, and PVCs for robust and scalable node operations.
• Set up an AWS EBS StorageClass to ensure efficient data storage solutions.

---

Changes walkthrough

	Relevant files
Configuration changes	archival-node-configmap.yaml Add ConfigMap for Archival Nodes                                                  kubernetes/devnet/base/farmer/archival-node-configmap.yaml Created a new ConfigMap for archival nodes with network and node identifiers. +15/-0    farmer-node-configmap.yaml Add ConfigMap for Farmer Nodes                                                      kubernetes/devnet/base/farmer/farmer-node-configmap.yaml Created a new ConfigMap for farmer nodes with necessary network and node configurations. +15/-0    pvc.yaml Define PVCs for Nodes                                                                        kubernetes/devnet/base/farmer/pvc.yaml Defined PersistentVolumeClaims for archival and farmer nodes with specific storage requirements. +25/-0    service.yaml Configure Network Service for Farmer Node                                kubernetes/devnet/base/farmer/service.yaml Created a new Kubernetes Service to manage network ports and protocols for the farmer node. +46/-0    storageclass-aws.yaml Setup AWS EBS StorageClass                                                              kubernetes/devnet/base/farmer/storageclass-aws.yaml Introduced a new AWS EBS StorageClass with specific parameters and policies. +13/-0
Enhancement	archival-node.yaml Setup StatefulSet for Archival Node                                            kubernetes/devnet/base/farmer/archival-node.yaml Introduced a new StatefulSet for the archival node with detailed pod specifications. Configured security settings, resource requests, and probes for the archival node. Set up network communication and command line arguments for node operations. +171/-0

---

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

[github-actions]

PR Description updated to latest commit (f45b7a9)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	4, because the PR involves multiple Kubernetes configurations across different resources such as ConfigMaps, StatefulSets, PVCs, and Services. Each of these configurations needs to be reviewed for correctness, security, and best practices in Kubernetes deployments. Additionally, the integration with AWS EBS requires scrutiny to ensure that there are no misconfigurations that could lead to performance issues or data loss.
🧪 Relevant tests	No
🔍 Possible issues	Possible Misconfiguration: The use of environment variables like ${DOCKER_TAG} and ${POT_EXTERNAL_ENTROPY} in the ConfigMap and StatefulSet configurations suggests a dependency on external configuration management. If these variables are not properly set in the environment where Kubernetes is running, it could lead to runtime errors or misconfigured deployments.
🔒 Security concerns	No

Code feedback:

---

relevant file	kubernetes/devnet/base/farmer/archival-node-configmap.yaml
suggestion	Consider adding validation for ConfigMap data fields to ensure that they are not empty. This can be done by using an admission controller or a custom operator that validates the configurations before they are applied to the cluster. This is important to prevent deployment of nodes with incomplete configurations, which could lead to failures in the network. [important]
relevant line	DOCKER_TAG: "${DOCKER_TAG}"

---

relevant file	kubernetes/devnet/base/farmer/archival-node.yaml
suggestion	It's recommended to parameterize the replicas field in the StatefulSet configuration to allow easy scaling of nodes. This can be managed through external configuration or command-line arguments when deploying or updating the StatefulSet. [medium]
relevant line	replicas: 1

---

relevant file	kubernetes/devnet/base/farmer/pvc.yaml
suggestion	For the PersistentVolumeClaims, consider specifying a more detailed accessModes setting depending on the actual usage pattern of the nodes. If concurrent access from multiple nodes is not required, sticking to ReadWriteOnce is fine, but if you anticipate such a need, ReadWriteMany might be necessary. [medium]
relevant line	accessModes:

---

relevant file	kubernetes/devnet/base/farmer/service.yaml
suggestion	Ensure that the service ports configuration aligns with the actual ports used by the applications within the pods. Misconfigured ports can lead to inaccessible services or security risks if unintended ports are exposed. [important]
relevant line	port: 30333

---

---

✨ 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 by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations 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, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

Category	Suggestions
Best practice	Replace hardcoded user/group IDs in security contexts with more flexible security settings. It is recommended to avoid using runAsUser, runAsGroup, and fsGroup with hardcoded user/group IDs for better flexibility and security practices. Instead, consider defining security contexts that do not require specific numeric IDs. kubernetes/devnet/base/farmer/archival-node.yaml [17-21] securityContext: - fsGroup: 1000 runAsNonRoot: true - runAsUser: 1000 - runAsGroup: 1000
Security	Validate or sanitize the DOCKER_TAG variable to ensure safe and expected runtime behavior. The DOCKER_TAG environment variable is used directly in the image path without validation. It's recommended to validate or sanitize these inputs to avoid potential security risks or runtime errors. kubernetes/devnet/base/farmer/archival-node.yaml [47] -image: ghcr.io/subspace/node:${DOCKER_TAG} +image: ghcr.io/subspace/node:{{ .Values.DOCKER_TAG | default "latest" }}
Enhancement	Add default values or error handling for environment variables to prevent runtime errors. The use of $(POT_EXTERNAL_ENTROPY) in the command arguments without any default or error handling could lead to failures if the variable is not set. Consider providing a default value or handling the case where it might not be set. kubernetes/devnet/base/farmer/archival-node.yaml [87-88] - "--pot-external-entropy" -- "$(POT_EXTERNAL_ENTROPY)" +- "${POT_EXTERNAL_ENTROPY:-default_entropy_value}"

---

✨ 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 every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations 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, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.