Skip to content

source-aws-cloudtrail: ensure inline schemas, updated cdk, poetry (where possible) #37122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions airbyte-integrations/connectors/source-aws-cloudtrail/Dockerfile

This file was deleted.

64 changes: 57 additions & 7 deletions airbyte-integrations/connectors/source-aws-cloudtrail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,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-aws-cloudtrail build
airbyte-ci connectors --name source-aws-cloudtrail build
```
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-aws-cloudtrail: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-aws-cloudtrail: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-aws-cloudtrail: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-aws-cloudtrail:dev .
# Running the spec command against your patched connector
docker run airbyte/source-aws-cloudtrail:dev spec
```

#### Run
Then run any of the connector commands as follows:
```
Expand Down Expand Up @@ -96,4 +147,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.

Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,28 @@ data:
ab_internal:
ql: 200
sl: 100
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
connectorSubtype: api
connectorType: source
definitionId: 6ff047c0-f5d5-4ce5-8c81-204a830fa7e1
dockerImageTag: 0.1.5
dockerImageTag: 0.1.7
dockerRepository: airbyte/source-aws-cloudtrail
documentationUrl: https://docs.airbyte.com/integrations/sources/aws-cloudtrail
githubIssueLabel: source-aws-cloudtrail
icon: awscloudtrail.svg
license: MIT
name: AWS CloudTrail
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-aws-cloudtrail
registries:
cloud:
enabled: true
oss:
enabled: true
releaseStage: alpha
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-aws-cloudtrail
supportLevel: community
tags:
- language:python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,52 @@
"type": "object",
"properties": {
"AccessKeyId": {
"description": "The unique identifier for the AWS access key used during the event.",
"type": ["null", "string"]
},
"CloudTrailEvent": {
"description": "The raw CloudTrail event data associated with the management event.",
"type": ["null", "string"]
},
"EventId": {
"description": "The identifier for the specific event recorded in CloudTrail.",
"type": ["null", "string"]
},
"EventName": {
"description": "The name of the management event that occurred.",
"type": ["null", "string"]
},
"EventSource": {
"description": "The service that the API call was made to.",
"type": ["null", "string"]
},
"EventTime": {
"description": "The timestamp when the event occurred.",
"type": ["null", "integer"]
},
"ReadOnly": {
"description": "Indicates whether the event was a read-only operation.",
"type": ["null", "string"]
},
"Resources": {
"description": "Information about the resources affected by the management event.",
"type": ["null", "array"],
"items": {
"type": ["null", "object"],
"properties": {
"ResourceName": {
"description": "The name of the affected resource.",
"type": ["null", "string"]
},
"ResourceType": {
"description": "The type of the affected resource.",
"type": ["null", "string"]
}
}
}
},
"Username": {
"description": "The username associated with the event.",
"type": ["null", "string"]
}
}
Expand Down
2 changes: 2 additions & 0 deletions docs/integrations/sources/aws-cloudtrail.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Please, follow this [steps](https://docs.aws.amazon.com/powershell/latest/usergu

| Version | Date | Pull Request | Subject |
| :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------ |
| 0.1.7 | 2024-04-15 | [37122](https://github.com/airbytehq/airbyte/pull/37122) | Base image migration: remove Dockerfile and use the python-connector-base image |
| 0.1.6 | 2024-04-12 | [37122](https://github.com/airbytehq/airbyte/pull/37122) | schema descriptions |
| 0.1.5 | 2023-02-15 | [23083](https://github.com/airbytehq/airbyte/pull/23083) | Specified date formatting in specification |
| 0.1.4 | 2022-04-11 | [11763](https://github.com/airbytehq/airbyte/pull/11763) | Upgrade to Python 3.9 |
| 0.1.3 | 2021-12-23 | [8434](https://github.com/airbytehq/airbyte/pull/8434) | Update fields in source-connectors specifications |
Expand Down
Loading