Run StreamX on local Kubernetes cluster
In this guide, we walk you through the process of setting up StreamX on a local cluster using Kubernetes in Docker Cluster
Prerequisites
Please ensure you have the following before proceeding:
-
Approximately 30 minutes to complete the setup.
-
Access to StreamX infrastructure-as-code repository. If you don’t have this, you can inquire at https://www.streamx.dev/contact-us.html
-
Docker resources are configured at least:
-
Memory limit: 8 GB
-
CPU limit: 8 cores
-
Virtual disk limit: 20 GB
-
| Ensure no other application is using ports 443 or 80. |
Step 1: Obtain the source files
Clone the Git repository that contains the source files for the example:
git clone https://github.com/streamx-dev/terraform-streamx-cloudOptional Step 2: Configure StreamX Mesh
The fetched repository already contains mesh configuration required to run StreamX. However, if you want to tailor the mesh configuration to your specific needs, you have that flexibility!
Within the fetched repository, there are two mesh.yaml files:
-
The base configuration is located in the
examples/terraform-streamx-blueprint/config/streamxdirectory. -
The overriding configuration is located in the
examples/terraform-streamx-blueprint/local/iac/config/streamxdirectory.
Terraform is set up to use the base configuration and then selectively overwrite the values with those defined in the override configuration. Hence, the settings in your override configuration take precedence.
In the provided example, the overriding mesh configuration alters the number of blueprint replicas within StreamX.
Step 4: Initialize the Terraform
This action fetches all resources required by Terraform.
terraform initStep 5: Prepare the Terraform plan
A Terraform plan displays an execution plan that is implemented in the subsequent steps.
terraform planStep 6: Validate and Implement plan
During this phase, Terraform generates and execute all necessary resources before creating the cluster. Command below can take up to 25 minutes to finish
terraform apply| Command above uses Streamx mesh.yaml file included in the 'terraform-streamx-cloud' repository. |
Optional Step 7: Validate StreamX
To verify your StreamX setup, you can publish a simple website and check its accessibility using the following script:
#!/bin/bash
INGESTION_URL=https://$(terraform output -json endpoints | jq -r '."ingestion"."rest"')
WEB_URL=https://$(terraform output -json endpoints | jq -r '."delivery"."blueprint_web"')
TOKEN="$(terraform output -raw ingestion_rest_jwt_token)"
curl -k -X PUT ${INGESTION_URL}/publications/v1/pages/published/puresight/pages/homepage.html -H "Authorization: Bearer ${TOKEN}" -H 'Content-Type: application/json' -d "{\"content\": {\"bytes\": \"<h1>Hello World!</h1>\"}}"
sleep 0.5
echo "\n\nReceived: "
curl -k ${WEB_URL}
echo "\n"