A Sceptre resolver to retrieve a kubernetes service load balancer URI
Project description
sceptre-eks-lb-resolver
Sceptre custom resolver you can use to dynamically read AWS EKS Load Balancer URI into your Sceptre config.
It reads services inside your Kubernetes cluster with type LoadBalancer
and returns its External DNS/URI.
Installation
$> pip install sceptre-eks-lb-resolver
Usage
Simply call the resolver inside your Sceptre configuration files:
template_path: mystack.yaml
parameters:
ProjectName: "My k8s API"
LoadBalancerURI: !eks_lb_uri -n backend -s data_api
Will resolve to something like:
LoadBalancerURI: "XXXXXXXXXXX.us-east-1.elb.amazonaws.com"
You can use your Sceptre variables as arguments for the resolver:
...
LoadBalancerURI: !eks_lb_uri -n {{ var.namespace }} -s {{ var.service }}
So with that in place, when you run sceptre launch --yes dev/us-east-1
, it
will call the resolver and assign the k8s load balancer URI to the Sceptre
variable LoadBalancerURI
at runtime.
Make sure to guarantee that you are properly authenticated within AWS
Syntax
Resolver expects two arguments: -n | --namespace
and -s | --service-name
.
The --namespace
argument is optional. It assumes kubeernetes default
namespace
as its default value.
All available ways of using this resolver are as follows:
LBArn: !eks_lb_uri --namespace {{ var.namespace }} --service-name {{ var.service }}
LBArn: !eks_lb_uri -n {{ var.namespace }} -s {{ var.service }}
LBArn: !eks_lb_uri -s {{ var.service }} # Assumes default namespace
LBArn: !eks_lb_uri -s "my_api_service_name"
LBArn: !eks_lb_uri -n backend -s data_api
How does it works?
The resolver is called by Sceptre in order to retrieve remote k8s cluster services. The EKS Load Balancer Resolver uses kubernetes python client to connect on the remote cluster and retrieve data of the given service name from a given namespace.
The K8s Load Balancer URI resolver simply tries to get the Load Balancer DNS as if you run:
$> kubectl --namespace backend get service api-service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
api-service LoadBalancer 10.0.42.123 XXXXXXXXXXX.us-east-1.elb.amazonaws.com 443:32214/TCP 12h40m
The resolver goes after the XXXXXXXXXXX.us-east-1.elb.amazonaws.com
value. When succeeds, it loads in place this
value in your Sceptre template.
Notes
Be aware that the shell which sceptre will be called MUST be authenticated on AWS and your kubeconfig properly updated to point to your AWS EKS remote cluster.
You can refer to the following links for either AWS and Kubernetes authentication:
Contributing
Fork, change, make test, make check, Pull Request. I will review the code and if Github Actions pipeline succeeds: congratulations! We are going to merge ;)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sceptre-eks-lb-resolver-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c816f362ec3d427f0906ea30f44a7a8bb9bfd355e60ee564d64c1f563123630f |
|
MD5 | 1f8218b1d72d45930ccc955c44965d7a |
|
BLAKE2b-256 | 286c54fe70743b138ab178c2a3ac2adb4fb4483a4c707d5b2fdf69ac4d6b0da0 |
Hashes for sceptre_eks_lb_resolver-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2f38e0866ba356fc9edf2a73b1dd58c01804e7ab26e58358fe7bc1bed08702c |
|
MD5 | c8281d92fe4ef54dc03a2db2b457e185 |
|
BLAKE2b-256 | d838d29def709a04bef78710a883043d6255cb56d43c7b60c890bab3c5d37475 |