mike Trienis
09/26/2024, 6:51 PMuser
09/26/2024, 6:52 PMairbyte-ci
tool to build your connector image and use a specific version number. The airbyte-ci
tool is a preferred method for building and testing connectors in Airbyte. Here are the steps to build the connector image: 1. Verify the airbyte-ci
tool is installed by running airbyte-ci --help
. If the command is not found, you need to install the tool. You can find the installation instructions in the [Prerequisites](https://docs.airbyte.com/contributing-to-airbyte/developing-locally#connector-contributions). 2. Run the command airbyte-ci connectors --name source-<source-name> build
to build your connector image. Replace <source-name>
with the name of your connector. 3. Once the command is done, you will find your connector image in your local docker host: airbyte/source-<source-name>:dev
. You can change the dev
tag to use another tag if you'd like via the docker image tag
command. This allows you to use a specific version number for your Docker image. For example, if you want to tag your image with version 0.1.0
, you can run the following command: bash docker tag airbyte/source-<source-name>:dev airbyte/source-<source-name>:0.1.0
Remember to replace <source-name>
with the name of your connector. After building and tagging the image, you can verify the image was published locally by running: bash docker images ls | grep airbyte/source-<source-name>:0.1.0
This should show the output similar to: bash airbyte/source-<source-name> | 0.1.0 | 70516a5908ce | 2 minutes ago | 968MB
You can find more details in the [Airbyte documentation](https://docs.airbyte.com/contributing-to-airbyte/developing-locally#connector-contributions).mike Trienis
09/26/2024, 7:00 PMuser
09/26/2024, 7:00 PMuser
09/26/2024, 7:00 PMairbyte-ci
. However, once you've built your Docker image using airbyte-ci
, you can manually push it to your custom Docker registry. Here's a general process: 1. Authenticate to your private Docker registry. This process varies depending on your registry provider. You can usually use the docker login
command. For example: bash docker login <http://myregistry.example.com|myregistry.example.com>
2. Tag your image with the registry's URL: bash docker tag airbyte/source-<source-name>:dev <http://myregistry.example.com/myimage:mytag|myregistry.example.com/myimage:mytag>
3. Push the image to your registry: bash docker push <http://myregistry.example.com/myimage:mytag|myregistry.example.com/myimage:mytag>
Remember to replace <http://myregistry.example.com|myregistry.example.com>
, myimage
, mytag
, and <source-name>
with your actual registry URL, image name, tag, and source name respectively. For more specific instructions, you should refer to your registry's documentation. If your registry is on a major cloud provider, you can refer to the [Airbyte documentation](https://docs.airbyte.com/operator-guides/using-custom-connectors#1-create-a-private-docker-registry) for links to their respective guides.