Idea and extension of cloud-iot-microservices-deployment.

• Overview
• Prerequisites
• Installation
• Configuration
  • Global Settings
  • Deployments
  • Services
  • Ingress
  • Databases
  • Service Account
  • ConfigMaps
• Running Tests
  • Viewing Test Results
• Uninstallation
• Values
• Secrets
  • Injecting Secrets Securely
  • Example Deployment Command with Secure Secrets
• Testing Your Chart
  • Linting the Chart
  • Template Rendering
  • Dry Run
  • Validate Kubernetes Manifests
  • Verify Dependencies
  • Check YAML Syntax
  • Unit Testing
• References

This Helm chart deploys a set of microservices for a Cloud IoT platform. It includes services like goApi, loki, and grafana, along with their corresponding configuration, deployment, and service resources.

This Helm chart is an extension of the Cloud IoT microservices deployment found in the cloud-iot-microservices-deployment repository. It builds on the Kubernetes manifests provided in the kubernetes directory of that project, offering a more streamlined, configurable, and reusable solution for deploying the platform's services.

The cloud-iot-chart serves as the main Helm chart for deploying the Cloud IoT platform. It manages the deployment of multiple dependencies, which include:

• Application: Manages the core microservices and applications required for the platform.
• Database: Handles the deployment of database services such as PostgreSQL and Redis.
• Monitoring: Deploys monitoring tools like Prometheus and Grafana.

These dependencies are configured in the Chart.yaml file as follows:

apiVersion: v2
name: cloud-iot-chart
description: A Helm chart for the Cloud IoT project
version: 0.1.0
dependencies:
  - name: application
    version: 0.1.0
    repository: file://charts/applications
  - name: monitoring
    version: 0.1.0
    repository: file://charts/monitoring
  - name: database
    version: 0.1.0
    repository: file://charts/database
    condition: database.enabled

The deployment of the database dependency is conditional, controlled by the database.enabled flag in the values.yaml file. If enabled, the database services (e.g., PostgreSQL, Redis) will be deployed alongside the application services.

Important Note:

The applcation deployment can have database dependency (env.TEST_PROPUSE=true on configmap). So the database.enabled flag must set to true, it's essential to deploy both the application and the database services together to avoid any runtime issues. Ensure that the dependent applications are also deployed to utilize the database services appropriately.

To deploy the chart with the database enabled, use the following command:

helm upgrade --install cloud-iot . \
  --set database.enabled=true

• Kubernetes cluster (v1.14 or later)
• Helm v3.0 or later
• kubectl CLI configured to communicate with your cluster

Install all Helm chart project:

helm install cloud-iot .

Install the specific Helm chart with the following command:

helm install cloud-iot ./charts/applications

Or, to upgrade an existing release:

helm upgrade --install cloud-iot ./charts/applications

You can pass in custom values using the --set flag or by specifying additional values files with -f.

For example:

helm upgrade --install cloud-iot ./charts/applications \
  --set secrets.postgres.user=$POSTGRES_USER \
  --set secrets.postgres.password=$POSTGRES_PASSWORD \
  --set secrets.postgres.database=$POSTGRES_DB

For deploying in different environments like dev, staging, or prod, you should organize your values files within the environments/ directory as follows:

helm upgrade --install cloud-iot ./charts/applications -f environments/dev/values.yaml

This allows you to maintain environment-specific configurations separately, ensuring cleaner and more manageable deployments.

Note: Environment-specific values are stored in separate files under the environments/ directory. This structure allows you to maintain configurations for dev, staging, and prod environments separately, ensuring that sensitive or environment-specific configurations do not overlap.

This section allows you to configure the deployments of various services within the platform.

This section allows you to configure Kubernetes services for the deployed applications.

This section allows you to configure ingress resources for the deployed services.

This section allows you to configure database-related settings.

This section covers global settings that are checked and used across different parts of the chart, particularly in the label generation logic.

This section allows you to configure service account settings.

Create a service account for the deployment | false |

This section allows you to configure ConfigMaps used by the deployed services.

The chart includes a set of test connection Pods that are automatically created for each enabled service to verify connectivity.

To manually trigger the tests after deployment, use the following command:

helm test cloud-iot

This command will run the tests for all services that are enabled in the values.yaml file.

You can check the status of the test Pods using:

kubectl get pods -l "helm.sh/hook=test"

To view the logs of a specific test Pod:

kubectl logs <test-pod-name>

To uninstall the Helm chart, use the following command:

helm uninstall cloud-iot

This command will remove all Kubernetes resources associated with the Helm release.

Here is a comprehensive table of all possible values and their descriptions.

(Include the detailed values table as previously)

• CI/CD Environment Variables: You can set environment variables in your CI/CD system and inject them during deployment using --set or by passing a separate secret values file.
• Values File Encryption: Consider using Helm plugins like Helm Secrets to encrypt your values files, providing an additional layer of security for sensitive data.

helm upgrade --install cloud-iot ./charts/applications \
  --values environments/prod/values.yaml \
  --set secrets.postgres.user=$POSTGRES_USER \
  --set secrets.postgres.password=$POSTGRES_PASSWORD \
  --set secrets.postgres.database=$POSTGRES_DB

Helm provides a built-in linting tool to check your chart for common issues:

helm lint ./charts/applications

You can render your Helm templates locally to see what the final Kubernetes YAML manifests will look like:

helm template cloud-iot ./charts/applications
helm template charts/database --debug
# Spec. Env
helm template cloud-iot --values environments/dev/values.yaml

Perform a dry run to simulate an installation:

helm install cloud-iot ./charts/applications --values environments/dev/values.yaml --dry-run --debug

After rendering the templates with helm template or helm install --dry-run, you can pipe the output to kubectl to validate the resulting Kubernetes manifests:

helm template cloud-iot ./charts/applications --values environments/dev/values.yaml | kubectl apply --dry-run=client -f -

Ensure that your chart's dependencies are up to date:

helm dependency update ./charts/applications

Use tools like yamllint to ensure that your YAML files are properly formatted:

yamllint ./charts/applications

Consider using tools like helm-unittest to write unit tests for your Helm charts.

• Helm Tips and Tricks
• Helm Cheat Sheet