source-faker: adopt our base image (#35172)

Author: alafanechere

airbyte-integrations/connectors/source-faker/Dockerfile

@@ -56,19 +56,70 @@ python main.py read --config secrets/config.json --catalog integration_tests/con
 ### Locally running the connector docker image
 
 
-#### Build
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+
+
+#### 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-faker build
+airbyte-ci connectors --name source-faker build
+```
+Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-faker: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")
 ```
 
-An image will be built with the tag `airbyte/source-faker:dev`.
+#### 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-faker:latest
+
+COPY . ./airbyte/integration_code
+RUN pip install ./airbyte/integration_code
 
-**Via `docker build`:**
+# 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-faker:dev .
+# Running the spec command against your patched connector
+docker run airbyte/source-faker:dev spec
 ```
-
 #### Run
 
 Then run any of the connector commands as follows:
@@ -108,4 +159,3 @@ You've checked out the repo, implemented a million dollar feature, and you're re
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
-

airbyte-integrations/connectors/source-faker/README.md

@@ -4,10 +4,12 @@ data:
     sl: 100
   allowedHosts:
     hosts: []
+  connectorBuildOptions:
+    baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
   connectorSubtype: api
   connectorType: source
   definitionId: dfd88b22-b603-4c3d-aad7-3701784586b1
-  dockerImageTag: 6.0.0
+  dockerImageTag: 6.0.1
   dockerRepository: airbyte/source-faker
   documentationUrl: https://docs.airbyte.com/integrations/sources/faker
   githubIssueLabel: source-faker
@@ -33,6 +35,10 @@ data:
       6.0.0:
         message: Declare 'id' columns as primary keys.
         upgradeDeadline: "2024-04-01"
+  remoteRegistries:
+    pypi:
+      enabled: true
+      packageName: airbyte-source-faker
   resourceRequirements:
     jobSpecific:
       - jobType: sync
@@ -45,10 +51,6 @@ data:
       - products
       - purchases
   supportLevel: community
-  remoteRegistries:
-    pypi:
-      enabled: true
-      packageName: airbyte-source-faker
   tags:
     - language:python
 metadataSpecVersion: "1.0"

airbyte-integrations/connectors/source-faker/metadata.yaml

@@ -101,6 +101,7 @@ None!
 
 | Version | Date       | Pull Request                                                                                                          | Subject                                                                                                         |
 | :------ | :--------- | :-------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- |
+| 6.0.1 | 2024-02-12 | [TBD](https://github.com/airbytehq/airbyte/pull/TBD) | Base image migration: remove Dockerfile and use the python-connector-base image |
 | 6.0.0   | 2024-01-30 | [34644](https://github.com/airbytehq/airbyte/pull/34644)                                                              | Declare 'id' columns as primary keys.                                                                                    |
 | 5.0.2   | 2024-01-17 | [34344](https://github.com/airbytehq/airbyte/pull/34344)                                                              | Ensure unique state messages                                                                                    |
 | 5.0.1   | 2023-01-08 | [34033](https://github.com/airbytehq/airbyte/pull/34033)                                                              | Add standard entrypoints for usage with AirbyteLib                                                              |