Migrate connectors to use our python base image (Round 2) (#31599)
This commit is contained in:
Augustin
@@ -1,17 +0,0 @@
|
||||
FROM python:3.9-slim
|
||||
|
||||
# Bash is installed for more convenient debugging.
|
||||
RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/*
|
||||
|
||||
WORKDIR /airbyte/integration_code
|
||||
COPY setup.py ./
|
||||
RUN pip install .
|
||||
COPY source_mixpanel ./source_mixpanel
|
||||
COPY main.py ./
|
||||
|
||||
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
|
||||
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
|
||||
|
||||
|
||||
LABEL io.airbyte.version=1.0.0
|
||||
LABEL io.airbyte.name=airbyte/source-mixpanel
|
||||
@@ -56,19 +56,70 @@ python main.py read --config secrets/config.json --catalog integration_tests/con
|
||||
|
||||
### Locally running the connector docker image
|
||||
|
||||
#### Build
|
||||
First, make sure you build the latest Docker image:
|
||||
|
||||
|
||||
#### Use `airbyte-ci` to build your connector
|
||||
The Airbyte way of building this connector is to use our `airbyte-ci` tool.
|
||||
You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
|
||||
Then running the following command will build your connector:
|
||||
|
||||
```bash
|
||||
airbyte-ci connectors --name source-mixpanel build
|
||||
```
|
||||
docker build . -t airbyte/source-mixpanel:dev
|
||||
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-mixpanel:dev`.
|
||||
|
||||
##### Customizing our build process
|
||||
When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
|
||||
You can customize our build process by adding a `build_customization.py` module to your connector.
|
||||
This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
|
||||
It will be imported at runtime by our build process and the functions will be called if they exist.
|
||||
|
||||
Here is an example of a `build_customization.py` module:
|
||||
```python
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
# Feel free to check the dagger documentation for more information on the Container object and its methods.
|
||||
# https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
|
||||
from dagger import Container
|
||||
|
||||
|
||||
async def pre_connector_install(base_image_container: Container) -> Container:
|
||||
return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
|
||||
|
||||
async def post_connector_install(connector_container: Container) -> Container:
|
||||
return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
|
||||
```
|
||||
|
||||
You can also build the connector image via Gradle:
|
||||
```
|
||||
./gradlew :airbyte-integrations:connectors:source-mixpanel:airbyteDocker
|
||||
```
|
||||
When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
|
||||
the Dockerfile.
|
||||
#### Build your own connector image
|
||||
This connector is built using our dynamic built process in `airbyte-ci`.
|
||||
The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
|
||||
The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
|
||||
It does not rely on a Dockerfile.
|
||||
|
||||
If you would like to patch our connector and build your own a simple approach would be to:
|
||||
|
||||
1. Create your own Dockerfile based on the latest version of the connector image.
|
||||
```Dockerfile
|
||||
FROM airbyte/source-mixpanel:latest
|
||||
|
||||
COPY . ./airbyte/integration_code
|
||||
RUN pip install ./airbyte/integration_code
|
||||
|
||||
# The entrypoint and default env vars are already set in the base image
|
||||
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
|
||||
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
|
||||
```
|
||||
Please use this as an example. This is not optimized.
|
||||
|
||||
2. Build your image:
|
||||
```bash
|
||||
docker build -t airbyte/source-mixpanel:dev .
|
||||
# Running the spec command against your patched connector
|
||||
docker run airbyte/source-mixpanel:dev spec
|
||||
```
|
||||
#### Run
|
||||
Then run any of the connector commands as follows:
|
||||
```
|
||||
@@ -128,4 +179,4 @@ You've checked out the repo, implemented a million dollar feature, and you're re
|
||||
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
|
||||
1. Create a Pull Request.
|
||||
1. Pat yourself on the back for being an awesome contributor.
|
||||
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
|
||||
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
|
||||
@@ -1,13 +1,19 @@
|
||||
data:
|
||||
ab_internal:
|
||||
ql: 400
|
||||
sl: 200
|
||||
allowedHosts:
|
||||
hosts:
|
||||
- mixpanel.com
|
||||
- eu.mixpanel.com
|
||||
connectorBuildOptions:
|
||||
baseImage: docker.io/airbyte/python-connector-base:1.1.0@sha256:bd98f6505c6764b1b5f99d3aedc23dfc9e9af631a62533f60eb32b1d3dbab20c
|
||||
connectorSubtype: api
|
||||
connectorType: source
|
||||
definitionId: 12928b32-bf0a-4f1e-964f-07e12e37153a
|
||||
dockerImageTag: 1.0.0
|
||||
dockerImageTag: 1.0.1
|
||||
dockerRepository: airbyte/source-mixpanel
|
||||
documentationUrl: https://docs.airbyte.com/integrations/sources/mixpanel
|
||||
githubIssueLabel: source-mixpanel
|
||||
icon: mixpanel.svg
|
||||
license: MIT
|
||||
@@ -21,7 +27,12 @@ data:
|
||||
releases:
|
||||
breakingChanges:
|
||||
1.0.0:
|
||||
message: In this release, the datetime field of stream engage has had its type changed from date-time to string due to inconsistent data from Mixpanel. Additionally, the primary key for stream export has been fixed to uniquely identify records. Users will need to refresh the source schema and reset affected streams after upgrading.
|
||||
message:
|
||||
In this release, the datetime field of stream engage has had its
|
||||
type changed from date-time to string due to inconsistent data from Mixpanel.
|
||||
Additionally, the primary key for stream export has been fixed to uniquely
|
||||
identify records. Users will need to refresh the source schema and reset
|
||||
affected streams after upgrading.
|
||||
upgradeDeadline: "2023-10-31"
|
||||
suggestedStreams:
|
||||
streams:
|
||||
@@ -32,11 +43,7 @@ data:
|
||||
- annotations
|
||||
- revenue
|
||||
- funnels
|
||||
documentationUrl: https://docs.airbyte.com/integrations/sources/mixpanel
|
||||
supportLevel: certified
|
||||
tags:
|
||||
- language:python
|
||||
ab_internal:
|
||||
sl: 200
|
||||
ql: 400
|
||||
supportLevel: certified
|
||||
metadataSpecVersion: "1.0"
|
||||
|
||||
Reference in New Issue
Block a user