-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into dependabot/npm_and_yarn/ui/types/node-18.19.71
- Loading branch information
Showing
10 changed files
with
210 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Audit Event Logging / Kafka Example | ||
|
|
||
| This example shows how you can run Flipt with audit event logging enabled using the `Kafka` audit sink. | ||
|
|
||
| This works by setting the environment variables: | ||
|
|
||
| ```bash | ||
| FLIPT_AUDIT_SINKS_KAFKA_ENABLED=true | ||
| FLIPT_AUDIT_SINKS_KAFKA_TOPIC=flipt-audit-events | ||
| FLIPT_AUDIT_SINKS_KAFKA_ENCODING=avro | ||
| FLIPT_AUDIT_SINKS_KAFKA_INSECURE_SKIP_TLS=true | ||
| FLIPT_AUDIT_SINKS_KAFKA_BOOTSTRAP_SERVERS=redpanda | ||
| FLIPT_AUDIT_SINKS_KAFKA_SCHEMA_REGISTRY_URL=http://redpanda:8081 | ||
| ``` | ||
|
|
||
| The auditable events currently are `created`, `updated`, and `deleted` operations on `flags`, `variants`, `segments`, `constraints`, `rules`, `distributions`, `namespaces`, and `tokens`. If you do any of these operations through the API, Flipt will emit an audit event log to the specified location. | ||
|
|
||
| ## Requirements | ||
|
|
||
| To run this example application you'll need: | ||
|
|
||
| * [Docker](https://docs.docker.com/install/) | ||
| * [docker compose](https://docs.docker.com/compose/install/) | ||
|
|
||
| ## Running the Example | ||
|
|
||
| 1. Run `docker compose up` from this directory | ||
| 1. Open the Flipt UI (default: [http://localhost:8080](http://localhost:8080)) | ||
| 1. Create some sample data: Flags/Segments/etc. | ||
| 1. Open the Redpanda UI (default: [http://localhost:8888/topics/flipt-audit-events](http://localhost:8888/topics/flipt-audit-events)) | ||
| 1. You should see a topic of audit events. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| version: "3" | ||
|
|
||
| name: flipt-audit-kafka | ||
| services: | ||
| flipt: | ||
| image: flipt/flipt:latest | ||
| command: ["./flipt", "--force-migrate"] | ||
| ports: | ||
| - "8080:8080" | ||
| environment: | ||
| - FLIPT_LOG_LEVEL=debug | ||
| - FLIPT_AUDIT_SINKS_LOG_ENABLED=true | ||
| - FLIPT_AUDIT_SINKS_KAFKA_ENABLED=true | ||
| - FLIPT_AUDIT_SINKS_KAFKA_TOPIC=flipt-audit-events | ||
| - FLIPT_AUDIT_SINKS_KAFKA_ENCODING=avro | ||
| - FLIPT_AUDIT_SINKS_KAFKA_INSECURE_SKIP_TLS=true | ||
| - FLIPT_AUDIT_SINKS_KAFKA_BOOTSTRAP_SERVERS=redpanda | ||
| - FLIPT_AUDIT_SINKS_KAFKA_SCHEMA_REGISTRY_URL=http://redpanda:8081 | ||
| - FLIPT_META_TELEMETRY_ENABLED=false | ||
| networks: | ||
| - flipt_network | ||
| depends_on: | ||
| redpanda: | ||
| condition: service_healthy | ||
| redpanda: | ||
| image: docker.redpanda.com/redpandadata/redpanda:v24.3.3 | ||
| command: | ||
| - redpanda start | ||
| - --kafka-addr internal://0.0.0.0:9092,external://0.0.0.0:19092 | ||
| - --advertise-kafka-addr internal://redpanda:9092,external://localhost:19092 | ||
| - --pandaproxy-addr internal://0.0.0.0:8082,external://0.0.0.0:18082 | ||
| - --advertise-pandaproxy-addr internal://redpanda:8082,external://localhost:18082 | ||
| - --schema-registry-addr internal://0.0.0.0:8081,external://0.0.0.0:18081 | ||
| - --rpc-addr redpanda:33145 | ||
| - --advertise-rpc-addr redpanda:33145 | ||
| - --mode dev-container | ||
| - --smp 1 | ||
| ports: | ||
| - 18081:18081 | ||
| - 18082:18082 | ||
| - 19092:19092 | ||
| - 19644:9644 | ||
| networks: | ||
| - flipt_network | ||
| healthcheck: | ||
| test: | ||
| ["CMD-SHELL", "rpk cluster health | grep -E 'Healthy:.+true' || exit 1"] | ||
| interval: 15s | ||
| timeout: 3s | ||
| retries: 5 | ||
| start_period: 5s | ||
| console: | ||
| image: docker.redpanda.com/redpandadata/console:v2.8.2 | ||
| entrypoint: /bin/sh | ||
| command: -c "echo \"$$CONSOLE_CONFIG_FILE\" > /tmp/config.yml; /app/console" | ||
| environment: | ||
| CONFIG_FILEPATH: /tmp/config.yml | ||
| CONSOLE_CONFIG_FILE: | | ||
| kafka: | ||
| brokers: ["redpanda:9092"] | ||
| schemaRegistry: | ||
| enabled: true | ||
| urls: ["http://redpanda:8081"] | ||
| redpanda: | ||
| adminApi: | ||
| enabled: true | ||
| urls: ["http://redpanda:9644"] | ||
| connect: | ||
| enabled: true | ||
| clusters: | ||
| - name: local-connect-cluster | ||
| url: http://connect:8083 | ||
| ports: | ||
| - 8888:8080 | ||
| networks: | ||
| - flipt_network | ||
| depends_on: | ||
| - redpanda | ||
| connect: | ||
| image: docker.redpanda.com/redpandadata/connectors:v1.0.23 | ||
| hostname: connect | ||
| container_name: connect | ||
| networks: | ||
| - flipt_network | ||
| depends_on: | ||
| - redpanda | ||
| ports: | ||
| - "8083:8083" | ||
| environment: | ||
| CONNECT_CONFIGURATION: | | ||
| key.converter=org.apache.kafka.connect.converters.ByteArrayConverter | ||
| value.converter=org.apache.kafka.connect.converters.ByteArrayConverter | ||
| group.id=connectors-cluster | ||
| offset.storage.topic=_internal_connectors_offsets | ||
| config.storage.topic=_internal_connectors_configs | ||
| status.storage.topic=_internal_connectors_status | ||
| config.storage.replication.factor=-1 | ||
| offset.storage.replication.factor=-1 | ||
| status.storage.replication.factor=-1 | ||
| offset.flush.interval.ms=1000 | ||
| producer.linger.ms=50 | ||
| producer.batch.size=131072 | ||
| CONNECT_BOOTSTRAP_SERVERS: redpanda:9092 | ||
| CONNECT_GC_LOG_ENABLED: "false" | ||
| CONNECT_HEAP_OPTS: -Xms512M -Xmx512M | ||
| CONNECT_LOG_LEVEL: info | ||
|
|
||
| networks: | ||
| flipt_network: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.