Component configuration
In this guide you’ll learn how to configure and deploy a component using Nuon. We’ll cover the different types of component configuration and how to use them. Then we’ll cover how to deploy your component to all of your provisioned Installs.
First you’ll need to go to the Components page and click the “Add a component” button. The component configuration panel should open. give your component a name then you can start configuring your component.
Now you’ll want to select which type of source configuration your component will need. Currently Nuon supports three types of source configurations:
- Docker build: Provide a Dockerfile that we’ll build and deploy;
- Docker image: Provide a Docker image from a container registry that we’ll deploy;
- None: No source needed because you want to use Helm to deploy;
If your component requires building an artifact from a Dockerfile you’ll need to provide the name of the Dockerfile and select a source repository. Nuon will need a source repository to pull the Dockerfile from. Currently Nuon supports two types of source repository, via a public Git repository or via a repository from a connected GitHub account.
Public Git repository
With a public Git repository you’ll only need to provide a URL to the repository you’d like to use (e.g.https://github.com/postmanlabs/httpbin.git) and the directory where the Dockerfile is located.
Connected GitHub repository
With a connected GitHub repository you’ll be able to select a repository from your connected GitHub account and provide the directory where the Dockerfile is located. Nuon will automatically use the default branch for the repository. If you haven’t connected a GitHub account to Nuon follow our guide to learn how.
If your component only requires a Docker image from a container registry Nuon currently supports two ways of doing thing. Via a public Docker image on Docker Hub or a private Docker image in your Elastic Container Registry account.
Public Docker Hub
With a public Docker image on Docker Hub you’ll only need to provide the image location (e.g. my-org/my-image) and the image tag you’d like to use.
Private Elastic Container Registry
With a private Docker image in your Elastic Container Registry (ECR) account you’ll need to provide the image location (i.e. a url to the image in your AWS account) and the image tag. You’ll also need to select which AWS region the image is located and provide an Amazon Resource Name (ARN) for an IAM role that will give Nuon access to pull the image from your ECR account.
Now that your component has an artifact configuration you’ll need to select which type of deployment configuration your component will need. Currently Nuon supports three types of deployment configurations:
- Basic Kubernetes: Set the pod configuration directly;
- Helm Repository: Use a Helm Chart from a public Helm Repository;
- None: No deployment configuration (you probably don’t want this);
To use a basic Kubernetes deployment you’ll need to set the number of instances you’d like to run, the service port of your artifact and a health check path for Kubernetes to use as a liveness probe.
To use a Helm Repository you’ll need to provide a URL to a public Helm Repository and the name of the Helm Charts you’d like to use. The public Helm Repository configuration doesn’t require an source configuration so you can set the artifact configuration type to “None”.
Now that your component is configured you can click the “Add a component” button at the bottom of the panel to add your component.
Now that you’ve added a component you can deploy it to all provisioned Installs (check out the Installs guide if you need to add an Install). On the components page click the component you’d like to deploy and the component detail panel should open. From the deployments tab click the “Deploy component” button. Your component will now start to deploy.
Now that you’ve deployed your component you can view the running instance of the component on individual Installs. Go to the Install page and click one of the provisioned Installs, the Install detail panel will open and you should see a list of active component instances. If the instance’s status is “active” you can now click the URL which will open a new tab with the running component instance in your customers’ Install.
Last modified 2mo ago