Skip to main content

Install add-ons

Add a capability to a cluster: certificates, DNS records, ingress, node autoscaling and more. AstroPulse installs the add-on, keeps it healthy and offers its upgrades; you pick the add-on and its settings. A dry run checks the exact install against the cluster before anything changes. The example installs Certificates on eks-prod. Which add-on does what: Add-ons.

Before you start​

  • A cluster that reads Ready, with no create, update or delete running on it.
  • For DNS Automation, and for Certificates with a DNS check, the cloud access the add-on needs: Cloud access for add-ons.

In the console​

  1. Open the cluster from the cluster list, select the Add-ons tab, then Install Add-on. A page opens with its steps down the side. The first step, Add-on, lists the add-ons by category, with Search add-ons… above them. An add-on this cluster cannot run is greyed out with the reason, an installed one shows its status, and one that needs another add-on says Requires and names it.

    Open zoom view

    Install Add-on on its first step: the add-ons by category, each with its status or what it needs

    Install Add-on on its first step: the add-ons by category, each with its status or what it needsInstall Add-on on its first step: the add-ons by category, each with its status or what it needs

  2. Pick Certificates, then Continue. Version chooses the newest release this cluster can run. Settings holds the add-on's top-level settings, then each block of its own settings has its own step, named after the block. Advanced holds Availability, Resources the main component's sizing and Components the sizing of its other components, where the add-on has them. A block whose settings depend on an earlier choice gets its step once that choice needs it. Documentation opens the add-on's page in a new tab. Not sure? Ask Nova, the Manifest and the step count stay at the top of the steps as you scroll, and Ask Nova answers about the open step. The step list lets you jump straight to Review.

    Open zoom view

    Installing Certificates: the version, Install CRDs, availability and resources

    Installing Certificates: the version, Install CRDs, availability and resourcesInstalling Certificates: the version, Install CRDs, availability and resources

  3. Review shows the whole manifest and starts the dry run by itself: AstroPulse checks this exact install against the cluster and changes nothing. A pass enables Continue to deploy, a refusal lists each reason, and the platform's advice shows beside it. Deploy with astroctl opens the file and the commands to do the same from a terminal.

  4. On Deploy, select Deploy cert-manager, then Follow in Events to open the new add-on on its Events.

You should see​

The add-on joins the Add-ons list, with its Version, Health, Availability and Status. Status reads Deploying, then Deployed. Select the row to open the add-on: its Overview lists each health check as Failing or Passing, and Events and Logs show the rollout.

Open zoom view

The Add-ons list with Node Autoscaling deployed and its health checks passing

The Add-ons list with Node Autoscaling deployed and its health checks passingThe Add-ons list with Node Autoscaling deployed and its health checks passing

What the dry run checks​

The dry run sends the same request as the install, with nothing applied. It checks the settings, the version against the cluster's Kubernetes version, the add-ons this one needs, and the cloud access it uses. A dry run answers for the settings it ran on: change a setting and Review runs it again before Continue to deploy is enabled.

Other ways in​

  • Nova: ask it, for example "install Certificates with a Let's Encrypt issuer on eks-prod". Nova shows the change and installs it after you approve it.
  • SDK and API: the same operations, in the API reference.

With astroctl​

List what the cluster can install, write the add-on's template, then apply it:

Terminal
astroctl infra k8s addons catalog eks-prod
astroctl infra k8s addons template eks-prod cert-manager > cert-manager.yaml
astroctl infra k8s addons apply -f cert-manager.yaml --dry-run
astroctl infra k8s addons apply -f cert-manager.yaml

The template lists every setting the add-on takes, each with what it does. A short manifest for the same install:

cert-manager.yaml
apiVersion: platform.astropulse.io/v1
kind: K8sClusterAddon
metadata:
  name: cert-manager
spec:
  clusterName: eks-prod
  configuration:
    certManager:
      issuerType: LetsEncrypt
      email: ops@example.com

Every flag: astroctl infra k8s addons apply.

If it's refused​

The refusals every add-on shares are on Manage add-ons. Each add-on's own are on its page.

Next​