Skip to content

Commit e009834

Browse files
thomaspoignantthomaspoignant
authored
docs: Add doc for kinesis (thomaspoignant#2606)
* add kinesis home page * Add documentation for relay-proxy
1 parent 2a249db commit e009834

File tree

7 files changed

+47
-17
lines changed

7 files changed

+47
-17
lines changed

‎website/docs/configure_flag/export_flags_usage.mdx

+25-11
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
sidebar_position: 40
33
description: How to export evaluation data?
44
---
5+
6+
7+
8+
9+
510
import {Cards} from '@site/src/components/doc/cardv2';
6-
import { ConfigCardContent } from "@site/src/components/doc/configCardContent";
11+
import {ConfigCardContent} from "@site/src/components/doc/configCardContent";
712
import customlogo from '@site/static/docs/collectors/custom.png';
813
import filelogo from '@site/static/docs/collectors/file.png';
914
import googlelogo from '@site/static/docs/collectors/google.png';
@@ -13,6 +18,7 @@ import webhooklogo from '@site/static/docs/collectors/webhook.png';
1318
import sqslogo from '@site/static/docs/collectors/sqs.png';
1419
import kafkalogo from '@site/static/docs/collectors/kafka.png';
1520
import pubsublogo from '@site/static/docs/collectors/pubsub.png';
21+
import kinesislogo from '@site/static/docs/collectors/kinesis.png';
1622

1723

1824
# How to export evaluation data
@@ -30,73 +36,81 @@ To use, simply configure and use the feature flag as normal, and analyze the col
3036
<Cards cards={[
3137
{
3238
logoImg: s3logo,
33-
title:"AWS S3",
39+
title: "AWS S3",
3440
content: <ConfigCardContent
3541
relayproxyLink={'../relay_proxy/configure_relay_proxy#s3-1'}
3642
goModuleLink={'../go_module/data_collection/s3'}
3743
/>
3844
},
3945
{
4046
logoImg: sqslogo,
41-
title:"AWS SQS",
47+
title: "AWS SQS",
4248
content: <ConfigCardContent
4349
relayproxyLink={'../relay_proxy/configure_relay_proxy#sqs'}
4450
goModuleLink={'../go_module/data_collection/sqs'}
4551
/>
4652
},
4753
{
4854
logoImg: kafkalogo,
49-
title:"Kafka",
55+
title: "Kafka",
5056
content: <ConfigCardContent
5157
relayproxyLink={'../relay_proxy/configure_relay_proxy#kafka'}
5258
goModuleLink={'../go_module/data_collection/kafka'}
5359
/>
5460
},
5561
{
5662
logoImg: googlelogo,
57-
title:"Google Storage",
63+
title: "Google Storage",
5864
content: <ConfigCardContent
5965
relayproxyLink={'../relay_proxy/configure_relay_proxy#google-storage-1'}
6066
goModuleLink={'../go_module/data_collection/google_cloud_storage'}
6167
/>
6268
},
6369
{
6470
logoImg: pubsublogo,
65-
title:"Google PubSub",
71+
title: "Google PubSub",
6672
content: <ConfigCardContent
6773
relayproxyLink={'../relay_proxy/configure_relay_proxy#google-pubsub'}
6874
goModuleLink={'../go_module/data_collection/google_pubsub'}
6975
/>
7076
},
7177
{
7278
logoImg: webhooklogo,
73-
title:"Webhook",
79+
title: "Webhook",
7480
content: <ConfigCardContent
7581
relayproxyLink={'../relay_proxy/configure_relay_proxy#webhook'}
7682
goModuleLink={'../go_module/data_collection/webhook'}
7783
/>
7884
},
7985
{
8086
logoImg: filelogo,
81-
title:"Local File",
87+
title: "Local File",
8288
content: <ConfigCardContent
8389
relayproxyLink={'../relay_proxy/configure_relay_proxy#file-1'}
8490
goModuleLink={'../go_module/data_collection/file'}
8591
/>
8692
},
8793
{
8894
logoImg: loglogo,
89-
title:"Webhook",
95+
title: "Log",
9096
content: <ConfigCardContent
9197
relayproxyLink={'../relay_proxy/configure_relay_proxy#log'}
9298
goModuleLink={'../go_module/data_collection/log'}
9399
/>
94100
},
101+
{
102+
logoImg: kinesislogo,
103+
title: "AWS Kinesis",
104+
content: <ConfigCardContent
105+
relayproxyLink={'../relay_proxy/configure_relay_proxy#aws-kinesis'}
106+
goModuleLink={'../go_module/data_collection/kinesis'}
107+
/>
108+
},
95109
{
96110
logoImg: customlogo,
97-
title:"Custom ...",
111+
title: "Custom ...",
98112
content: <ConfigCardContent
99113
goModuleLink={'../go_module/data_collection/custom'}
100114
/>
101115
},
102-
]} />
116+
]}/>

‎website/docs/relay_proxy/configure_relay_proxy.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ ex: `AUTHORIZEDKEYS_EVALUATION=my-first-key,my-second-key`)_.
3838
| `listen` | int | `1031` | This is the port used by the relay proxy when starting the HTTP server. |
3939
| `pollingInterval` | int | `60000` | This is the time interval **in millisecond** when the relay proxy is reloading the configuration file.<br/>The minimum time accepted is 1000 millisecond. |
4040
| `enablePollingJitter` | boolean | `false` | Set to true if you want to avoid having true periodicity when retrieving your flags. It is useful to avoid having spike on your flag configuration storage in case your application is starting multiple instance at the same time.<br/>We ensure a deviation that is maximum ±10% of your polling interval.<br />Default: false |
41-
| `DisableNotifierOnInit` | boolean | `false` | If **true**, the relay proxy will not call any notifier when the flags are loaded during initialization. This is useful if you do not want a Slack/Webhook notification saying that the flags have been added every time you start the proxy.<br/>Default: **false** |
41+
| `DisableNotifierOnInit` | boolean | `false` | If **true**, the relay proxy will not call any notifier when the flags are loaded during initialization. This is useful if you do not want a Slack/Webhook notification saying that the flags have been added every time you start the proxy.<br/>Default: **false** |
4242
| `hideBanner` | boolean | `false` | Should we display the beautiful **go-feature-flag** banner when starting the relay proxy |
4343
| `enableSwagger` | boolean | `false` | Enables Swagger for testing the APIs directly. If you are enabling Swagger you will have to provide the `host` configuration and the Swagger UI will be available at `http://<host>:<listen>/swagger/`. |
4444
| `host` | string | `localhost` | This is the DNS you will use to access the relay proxy. This field is used by Swagger to query the API at the right place. |
@@ -257,16 +257,26 @@ the [doc](../go_module/store_file/redis#expected-format) available._
257257

258258
| Field name | Type | Default | Description |
259259
|-------------------|----------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
260+
| `kind` | string | **none** | **(mandatory)** Value should be **`kafka`**.<br/>_This field is mandatory and describes which retriever you are using._ |
260261
| `kafka.topic` | string | **none** | **(mandatory)** Kafka topic to bind to. |
261262
| `kafka.addresses` | []string | **none** | **(mandatory)** List of bootstrap addresses for the Kafka cluster. |
262263
| `kafka.config` | object | _see description_ | This field allows fine tuning of the Kafka reader. This object should contain the [Sarama configuration](https://pkg.go.dev/github.com/IBM/sarama#Config) that the reader will use. On empty, a sensible default is created using [sarama.NewConfig()](https://pkg.go.dev/github.com/IBM/sarama#NewConfig) |
263264

264265
### Google PubSub
265266

266-
| Field name | Type | Default | Description |
267-
|-------------|--------|----------|------------------------------------------------------------------|
268-
| `projectID` | string | **none** | **(mandatory)** Value should be ID of GCP project you are using. |
269-
| `topic` | string | **none** | **(mandatory)** Topic name on which messages will be published. |
267+
| Field name | Type | Default | Description |
268+
|-------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------|
269+
| `kind` | string | **none** | **(mandatory)** Value should be **`pubsub`**.<br/>_This field is mandatory and describes which retriever you are using._ |
270+
| `projectID` | string | **none** | **(mandatory)** Value should be ID of GCP project you are using. |
271+
| `topic` | string | **none** | **(mandatory)** Topic name on which messages will be published. |
272+
273+
### AWS Kinesis
274+
275+
| Field name | Type | Default | Description |
276+
|--------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------|
277+
| `kind` | string | **none** | **(mandatory)** Value should be **`kinesis`**.<br/>_This field is mandatory and describes which retriever you are using._ |
278+
| `streamArn` | string | **none** | **(mandatory)** The ARN of your kinesis stream. |
279+
| `streamName` | string | **none** | The name of your kinesis stream. |
270280

271281
<a name="notifier"></a>
272282

‎website/src/components/home/features/index.js

+6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import PropTypes from 'prop-types';
66
import sqslogo from '@site/static/docs/collectors/sqs.png';
77
import pubsublogo from '@site/static/docs/collectors/pubsub.png';
88
import s3logo from '@site/static/docs/collectors/s3.png';
9+
import kinesislogo from '@site/static/docs/collectors/kinesis.png';
910
import webhooklogo from '@site/static/docs/collectors/webhook.png';
1011
import {Headline} from '../headline';
1112

@@ -308,6 +309,11 @@ function Integration() {
308309
fontAwesomeIcon="devicon-redis-plain-wordmark colored"
309310
tooltipText="Redis"
310311
/>
312+
<SocialIcon
313+
colorClassName={styles.socialIconAws}
314+
img={kinesislogo}
315+
tooltipText="AWS Kinesis"
316+
/>
311317
</div>
312318
</div>
313319
</div>

‎website/src/components/home/features/styles.module.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
}
3939

4040
.socialIconAws {
41-
background-color: rgb(255, 153, 0);
41+
background-color: #222e3c;
4242
}
4343

4444
.socialIconPubSub {

‎website/static/docs/collectors/kinesis.png

2.04 KB
Loading

‎website/static/docs/collectors/s3.png

-71.4 KB
Loading

‎website/static/docs/collectors/sqs.png

-5.39 KB
Loading

0 commit comments

Comments
 (0)