Create an environment
When you create a project, you'll need to create at least one environment. This page describes how to create an environment in more detail.
Watch a video
Transcript
0:01 Hi, welcome back. In this video I'll show you how to create an additional environment. In the last video you went through the creation of a project and the first environment.
0:15 If you remember we created the production environment which corresponds to the first environment. We're going to go through the main branch.
0:23 What I'm going to do in this video is create an additional environment called develop which will correspond to the dev branch in our project.
0:33 Now as far as ways that you can do that you can for example click new environment. Or you can go into the project.
0:44 At the top here you will see any environments that you have in this project. If you want to create an additional environment you can just click here and then you environment.
1:03 So as I was saying earlier I'm going to create create a develop environment. And that's going to correspond to the dev branch.
1:13 So I'll need to create the dev branch. So I'm just going to create a new branch. Dev and I'm branching off main branch for dev.
1:26 So I can just go ahead now and create the branch. This branch isn't going to be protected. My main branch has protected, but I'm going to do the bulk of my work in dev.
1:41 And then when I'm ready to put that work in into production, I'll need to create a pull request and then get that pull request approved and merged.
1:54 I'll show you how to do that in another video. So for now, let's just continue. Following configuration is pretty much the same as we saw in the first video.
2:06 So I'll quickly go through this to create the new environment. So you can see now the dev environment has been created.
2:19 So that's it for creating a new environment. Remember, there's always more than one way to do these things. But with a bit of exploration and playing around, you, you can find the different ways of and the most convenient way for you of creating the environment.
2:36 Okay. That's it for this video. See you in the next video.
How to create a new environment
There are several ways you can create a new environment, if you've not created one as part of creating the project. For example, you can do it from the top-level kebab menu:
You can also create an environment from the main project screen:
Name and branch
You now need to give your environment a name, and select (or create) the branch it is associated with:
You can enter any suitable name for your environment. Examples could be: production, testing, develop, staging, prototype, and so on. Any name that suits the use case can be used.
An environment is always associated with a branch. You can select a branch that already exists (such as when you have connected your project to an existing Git repository), but you are also free to create any new branches you need - simply click + New branch from the branch dropdown, in the Environment settings dialog.
Broker settings
You now choose the Kafka broker you use with Quix.
There are three broker options:
- Quix broker
- Managed Kafka (using a broker provider)
- Self-hosted
Each of these is described briefly in the following sections.
Quix broker
The simplest and most convenient choice is to use Quix-managed Kafka. No installation of Kafka is required, and configuration can be done through the UI if you need to change the sensible default values. Very little knowledge of Kafka is expected, beyond basic familiarity with concepts such as topics.
There is a small charge for storage for messages persisted in a topic:
Managed Kafka
Quix has integrations with common Kafka hosting providers. There are three options here:
Select your managed broker option, and then follow the detailed setup guide provided to connect Quix to the broker.
Self-hosted Kafka
If you want to install and manage your own Kafka installation, you can do this too, as long as the Kafka Cluster is available on the Internet. You'll need to do more configuration, and be very familiar with details of Kafka hosting and configuration. Selecting this option presents you with a setup guide:
You also have the option to test your connection with the Kafka server before continuing.
Broker setup guides
As well as the guides built into Quix Cloud to help set up your broker, there are also some setup guides in the Integrations documentation.
Data and streaming services
The last step in creating an environment is to choose your data and streaming services option.
There are two options here:
- Standard
- High performance
These options determine the following:
- The amount of storage available to persisted topics
- The level of resources (CPU, RAM) allocated to streaming services
Persisted storage
Persisted storage is when you enable persistence on a topic:
When this option is selected, data in the topic is persisted to a Quix database (InfluxDB). This data can then be queried using the Query API, or played back into a topic using the replay service.
Note
Persisted storage is not the same as topic storage. Topic storage is charged separately, and relates to storage allocated to messages retained in a Kafka topic, for the Quix broker option.
Streaming services
Services that experience improved performance when selecting the "High performance" option include the following:
- GitService - this is the service that synchronizes your Quix environment with the project's Git repository.
- Replay Service - enables replay of persisted data into a topic.
- Streaming Reader - service that enables a client to subscribe to a Quix topic.
- Streaming Writer - service that enables a client to publish to a Quix topic.
- Query API - query data persisted in the Quix database.
Generally, if you notice sluggish performance in one of these services, it may mean for the volumes and frequency of data you are processing, you might need the High performance option.
Tip
While you can't directly upgrade a standard environment to a high performance environment, you can create a new environment that uses the high performance option. You can create this environment using any branch (or even a new branch) suitable for your use case. For example, if you had a staging branch that was currently a standard environment, and you needed to upgrade it to a high performance environment, you could delete the environment, and create a new environment using the high performance option, and link it to the staging branch.
Use cases
Standard is designed for proof-of-concept, experimentation, and testing environments.
High performance is designed for production environments.