Flex is the all-in-one toolkit to manage, monitor, and learn about your Flink resources.
This Helm chart uses the factorhouse/flex container from Dockerhub.
This repository contains a single Helm chart that uses the factorhouse/flex container on Dockerhub.
To run the Dockerhub container requires a license. Start a free 30-day trial of Flex today.
You need to connect to a Kubernetes environment before you can install Flex.
The following examples demonstrate installing Flex in Amazon EKS.
aws eks --region <your-aws-region> update-kubeconfig --name <your-eks-cluster-name>
Updated context arn:aws:eks:<your-aws-region>:123123123:cluster/<your-eks-cluster-name> in /your/.kube/config
kubectl get svc
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kubernetes ClusterIP 12.345.6.7 <none> 443/TCP 28h
Add the Helm Repository in order to use the Flex Helm Chart.
helm repo add factorhouse https://charts.factorhouse.io
Update Helm repositories to ensure you install the latest version of Flex.
helm repo update
The minimum information required by Flex to operate is:
See the Flex Documentation for a full list of configuration options.
Some fields require quoting of characters within the value-string when using –set env.XXX to pass configuration.
This particularly applies to commas, integers, and quotation marks (see examples below).
Note, when using --set you may need to escape special characters with \, see:
https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of-set
Use the following to install from command line:
helm install --namespace factorhouse --create-namespace flex factorhouse/flex \
--set env.LICENSE_ID="00000000-0000-0000-0000-000000000001" \
--set env.LICENSE_CODE="FLEX_CREDIT" \
--set env.LICENSEE="Factor House\, Inc." \ <-- note the quoted comma
--set env.LICENSE_EXPIRY="2022-01-01" \
--set env.LICENSE_SIGNATURE="638......A51" \
--set env.FLINK_REST_URL="http://flink-dev.svc"
NAME: flex
LAST DEPLOYED: Mon May 31 17:22:21 2021
NAMESPACE: factorhouse
STATUS: deployed
REVISION: 1
NOTES:
1. Get the application URL by running these commands:
export POD_NAME=$(kubectl get pods --namespace factorhouse -l "app.kubernetes.io/name=flex,app.kubernetes.io/instance=flex" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:3000 to use your application"
kubectl --namespace factorhouse port-forward $POD_NAME 3000:3000
You can configure Flex with a ConfigMap of environment variables as follows:
helm install --namespace factorhouse --create-namespace flex factorhouse/flex --set envFromConfigMap=flex-config
This approach expects a ConfigMap to be available within the factorhouse namespace in kube, to understand how to configure Flex with a local ConfigMap template see Start Flex with Local Changes.
See flex-config.yaml.example for an example ConfigMapfile.
See the Kubernetes documentation on configuring all key value pairs in a config map as environment variables for more information.
Follow the notes instructions to set the $POD_NAME variable and configure port forwarding to the Flex UI.
export POD_NAME=$(kubectl get pods --namespace factorhouse -l "app.kubernetes.io/name=flex,app.kubernetes.io/instance=flex" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:3000 to use your application"
kubectl --namespace factorhouse port-forward $POD_NAME 3000:3000
Flex is now available on http://127.0.0.1:3000.
kubectl describe pods --namespace factorhouse
Name: flex-9988df6b6-vvf8z
Namespace: factorhouse
Priority: 0
Node: ip-172-31-33-42.ap-southeast-2.compute.internal/172.31.33.42
Start Time: Mon, 31 May 2021 17:22:22 +1000
Labels: app.kubernetes.io/instance=flex
app.kubernetes.io/name=flex
pod-template-hash=9988df6b6
Annotations: kubernetes.io/psp: eks.privileged
Status: Running
kubectl logs --namespace factorhouse $POD_NAME
11:36:49.111 INFO [main] flex.system ? start Flex
...
helm delete --namespace factorhouse flex
You can run Flex with local edits to these charts and provide local configuration when running Flex.
helm pull factorhouse/flex --untar --untardir .
Make any edits required to flex/Chart.yaml or flex/values.yaml (adding volume mounts, etc).
The command to run local charts is slightly different, see ./flex rather than factorhouse/flex.
helm install --namespace factorhouse --create-namespace flex ./flex <.. --set configuration, etc ..>
Place your local ConfigMap in the ./flex/templates/ directory.
Your local ConfigMap can then be referenced with --set envFromConfigMap=flex-config.
helm install --namespace factorhouse --create-namespace flex ./flex --set envFromConfigMap=flex-config
See flex-config.yaml.example for an example ConfigMap file.
See the Kubernetes documentation on configuring all key value pairs in a config map as environment variables for more information.
This helm chart accepts the name of a secret containing sensitive parameters, e.g.
apiVersion: v1
kind: Secret
metadata:
name: flex-secrets
data:
SASL_JAAS_CONFIG: a3JnLmFwYWNoXS5rYWZrYS5jb21tb24uc2VjdXJpdHkucGxhaW4uUGxhaW5Mb2dpbk2vZHVsZSByZXF1aXJiZCB1c2VybmFtZT0iTFQ1V0ZaV1BRWUpHNzRJQyIgcGFzc3dvcmQ9IjlYUFVYS3BLYUQxYzVJdXVNRjRPKzZ2NxJ0a1E4aS9yWUp6YlppdlgvZnNiTG51eGY4SnlFT1dUeXMvTnJ1bTAiBwo=
CONFLUENT_API_SECRET: NFJSejlReFNTTXlTcGhXdjNLMHNYY1F6UGNURmdadlNYT0ZXSXViWFJySmx2N3A2WStSenROQnVpYThvNG1NSRo=
kubectl apply -f ./flex-secrets.yaml --namespace factorhouse
Then run the helm chart (this can be used in conjunction with envFromConfigMap)
See the Kubernetes documentation on configuring all key value pairs in a secret as environment variables for more information.
helm install --namespace factorhouse --create-namespace flex ./flex --set envFromSecret=flex-secrets --set envFromConfigMap=flex-config
There are occasions where you must provide files to the Flex Pod in order for Flex to run correctly, such files include:
How you provide these files is down to user preference, we are not able to provide any support or instruction in this regard.
You may find the Kubernetes documentation on injecting data into applications useful.
These charts run Flex with Guaranteed QoS, having resource request and limit set to these values by default:
resources:
limits:
cpu: 2
memory: 8Gi
requests:
cpu: 2
memory: 8Gi
These default resource settings are conservative, suited to a deployment of Flex that manages multiple Flink clusters and associated resources.
When running Flex with a single Flink cluster you can experiment with reducing those resources as far as our suggested minimum:
resources:
limits:
cpu: 1
memory: 2Gi
requests:
cpu: 1
memory: 2Gi
Adjust these values from the command line like so:
helm install --namespace factorhouse --create-namespace flex factorhouse/flex \
--set resources.limits.cpu=1 \
--set resources.limits.memory=2Gi \
--set resources.requests.cpu=1 \
--set resources.requests.memory=2Gi
We recommend always having limits and requests set to the same value, as this set Flex in Guaranteed QoS and provides a much more reliable operation.
If you have any issues or errors, please contact [email protected].
This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.