In our installation process we've made a few assumptions, these are all about what is already installed in your cluster. If your configuration is different, it's still possible to install Heighliner, but you might have to change some of the installation files found in docs/kube.
We've provided an installation command which lets you generate the correct manifest files which you can then apply to your cluster. These generated manifests make some assumptions of operators installed in your cluster:
- Ingress Nginx as an Ingress
- Cert Manager for TLS Certificate management
- External DNS for DNS configuration
To generated these manifests and apply them to your cluster, run the following commands:
$ make bins && ./bin/heighliner install --version <HEIGHLINER_VERSION> \ --github-callback-domain <GITHUB_CALLBACK_DOMAIN> \ --dns-provider <EXTERNAL_DNS_PROVIDER> \ | kubectl apply -f -
We recommend you use a specific version, like
0.1.0 instead of
will prevent unexpected breaking changes if your Deployment gets rescheduled.
The DNS Provider should match what is provisioned through External DNS.
The GitHub Callback Domain is used to set up webhooks with GitHub. This should be the domain only. More information can be found here.
We've templated our installation files so we can install things dynamically. The key attributes that should be filled in are:
- Version: the version of Heighliner to install
- GitHubAPIToken: the API token to use when communicating with GitHub
- DNSProvider: the DNS provider that is set up with ExternalDNS
The GitHubCallbackDomain is used to link the cluster with GitHub. This is further described in the GitHub Connector documentation.
We'll also need an API Token which will allow us to actually communicate with GitHub. This API Token is only needed when you install a new GitHubRepository into your cluster.
Applying the files
Once the attributes are filled in, we can go ahead and apply the files:
$ kubectl apply -f docs/kube
This will set up all the controllers and install the necessary RBAC rules. The controllers will then install the CRDs accordingly.
Now that we have Heighliner up and running, we can start installing Microservices.