https://github.com/bundesapi/orgchart-crawler
https://github.com/bundesapi/orgchart-crawler
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bundesapi/orgchart-crawler
- Owner: bundesAPI
- Created: 2022-01-06T02:41:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-13T07:31:07.000Z (almost 4 years ago)
- Last Synced: 2025-03-11T06:29:32.386Z (over 1 year ago)
- Language: Python
- Size: 188 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Strukturen-ML
This service can be used via an SNS-Topic asynchronously.
## Supported SNS Messages
Every method works the same way with the same GET-Parameters as documented in the API Documentation.
### Update all orgcharts
**Topic:** ```orgchart-crawler-bund-dev```
```json
{
"action": "crawl-all-orgcharts",
"parameters": {
}
}
```
## Service Configuration
This service is partly configured via [terraform](https://github.com/bundesAPI/terraform/blob/main/orgchart_crawler.tf). The deployment pipeline (via serverless.yaml) needs the following environment variables in its build context:
| Variable | Value |
|----------------------------------|----------------------------------------------------------------------------------------------------------------------|
| ORGCHART_CRAWLER_SNS_TOPIC | SNS Topic ARN for orgchart crawler jobs |
| SENTRY_DSN | sentry monitoring dsn… |
| SENTRY_PROJECT | sentry project name (orgchart-ml) |
| SERVICE_DOMAIN | backend service domain |
| CLIENT_ID | to authenticate as a service via oauth2 client credentials |
| CLIENT_SECRET | to authenticate as a service via oauth2 client credentials |
| LAMBDA_EXECUTION_ROLE_ARN | the iam rule that executes the lambda. Needs access to lambda, the buckets, the queues and cloudwatch |
| DOMAIN | the domain this service is running under. Needs to be configured for gateway and already an tls certificate assigned |