Skip to content

Commit

Permalink
chore: update ingest docs
Browse files Browse the repository at this point in the history
  • Loading branch information
frytg committed Jan 26, 2023
1 parent 12dcd87 commit 1c7ea54
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 32 deletions.
42 changes: 42 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# docs: https://editorconfig.org
# please make sure to keep this file in sync between repositories
# to main file should be edited in `swr-prettier-config` and copied where needed

root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = tab
indent_size = 8
print_width = 111
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
indent_style = space
indent_size = 2

[*.{yml,yaml}]
indent_style = space
indent_size = 2

# LiquidSoap config files
[*.liq]
indent_style = space
indent_size = 2

# Terraform config files
[*.tf]
indent_style = space
indent_size = 2

# Linting toml config files
[*.toml]
indent_style = space
indent_size = 2

# Auto-generated CSV Files
[*.csv]
insert_final_newline = false
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ yarn-error.log*
.DS_STORE

# keys
keys/*.json
keys/
.env

# Dependency directories
Expand Down
Empty file removed keys/.gitkeep
Empty file.
11 changes: 0 additions & 11 deletions keys/secret.example.yaml

This file was deleted.

35 changes: 15 additions & 20 deletions src/ingest/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# ARD-Eventhub

## Ingest
# ARD-Eventhub Ingest

The Ingest service is used to accept incoming events, distribute them via Pub/Sub and provide methods for users to manage their own subscriptions (self-service).

### Environments
- [ARD-Eventhub Ingest](#ard-eventhub-ingest)
- [Environments](#environments)
- [Stages](#stages)
- [DEV](#dev)
- [PROD](#prod)
- [Setup](#setup)
- [Deployment](#deployment)

## Environments

Designated host is Kubernetes but the Docker container will also be used in other environments such as Google Cloud Run for testing purposes.

Expand All @@ -18,15 +24,15 @@ Several environment variables need to be set in `.env` config in order to run th
- OPTIONAL `PORT` - override server port setting, default is 8080
- OPTIONAL `DEBUG` - set true to enable more detailed logging

### Stages
## Stages

Some staging information is auto-detected (whether to run tracing or not), some is configured by the `STAGE` variable.

#### DEV
### DEV

Main difference is the prefix used for Pub/Sub topics, which includes `DEV-`.

#### PROD
### PROD

Uses full production prefixes and configuration.

Expand All @@ -51,21 +57,10 @@ To run this project locally in your development environment you'll need these pr
yarn ingest:local
```

6. Open http://localhost:8080/openapi/
6. Open [localhost:8080/openapi](http://localhost:8080/openapi/)

## Deployment

The deployment process of Eventhub-Ingest is different for `Non-Prod` and `Prod`-Stages

### Dev, Test, Stage

Deployments for Stages `Dev`, `Test` and `Stage` can be done in Github-Actions after the run completed successful.

### Prod

Deployments for `Prod` need to be done by external ARD-Service. Therefore request the rollout by sending following E-Mail:

- To: `[email protected]`
- Cc: `[email protected]`
- Subject: Prod-Deployment of Eventhub-Ingest
- Text: I request to deploy the following version of the eventhub-ingest on prod: `<docker-version-tag>`
Deployments for all stages will be done in Github-Actions after the run completed successful.

0 comments on commit 1c7ea54

Please sign in to comment.