README.md 4.67 KB
Newer Older
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
1
# Gitlab RSS Sync
2
3
Create Gitlab issues from RSS Feeds with optional labelling.  Created to monitor RSS feeds and bring posts to
our attention (Security Releases, Product Updates etc)
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
4

5
6
7
8
9
10
## Avoiding Duplication
We try to be as clever as is reasonably possible in terms of not duplicating RSS feed items into Gitlab.
A SQLite DB is used to store the GUID/FeedID combination which is checked when assessing articles for synchronisation.
In addition we also add the RSS feed's item GUID at the bottom of the issue description.  Before synchronising an RSS item
we run an issue search in the associated project, if we dont find the GUID in any issue we assume its not already been created.
This helps to guard against scenarios where you lose the SQLite DB and dont want RSS items reduplicating into Gitlab.
Adam Harrison-Fuller's avatar
Tidyup    
Adam Harrison-Fuller committed
11
If found in Gitlab it is marked as synchronised in the local database as well as printing an link to the existing issue(s) to stdout.
12
13
14
15
16
17

## Limiting what is initially synced.
Each feed entry in the config file can have an "added_since" property set.  This is used to only sync RSS items that have a
Published/Updated date greater than the provided value.  This can be useful on RSS feeds where you dont want to import historic items,
just new posts going forward.

Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
18
## Config file
19
20
21
22
23

The config file **MUST** be named config.yaml, an example one is provided [here](config.yaml.example).  Below is a brief
 description of its contents.

```yaml
24
interval: 300
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
25
feeds:
26
27
28
29
30
31
  - id: test 
    feed_url: http://example.com/rss.xml
    name: Test Feed
    gitlab_project_id: 12345
    added_since: "2019-03-27T15:00:00Z"
    labels:
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
32
      - TestLabel
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
33
34
   - id: feed2
     ...
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
35
```
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
### Global
| Attribute | Type | Required | Description                                 |
|-----------|------|----------|---------------------------------------------|
| interval  | int  | yes      | The interval in seconds between feed checks |

### Feeds
| Attribute         | Type   | Required | Description                                                                                           |
|-------------------|--------|----------|-------------------------------------------------------------------------------------------------------|
| id                | string | yes      | A feed ID that is used internally for duplicate detection.                                            |
| feed_url          | string | yes      | The URL of the feed                                                                                   |
| name              | string | yes      | A User friendly display name.                                                                         |
| gitlab_project_id | int    | yes      | The Gitlab project ID to create issues under.                                                         |
| added_since       | string | no       | For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this |
| Labels            | Array  | no       | A list of labels to add to created Issues                                                             |


Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

## Docker
A Docker image is made available on [DockerHub](https://hub.docker.com/r/adamhf/gitlabrsssync)

### Required Environment Variables
* GITLAB_API_TOKEN - Gitlab personal access token that will be used to create Issues NOTE: You must have access to create
issues in the projects you specify in the config file.
* CONFIG_DIR - The directory the application should look for config.yaml in.
* DATA_DIR - The directory the application should look for (or create) the state.db in.

### Volume mounts
Make sure the location of your DATA_DIR environment variable is set to a persistant volume / mount as the database
that is contained within it stores the state of which RSS items have already been synced.

### Run it
67
```bash
68
docker run -e GITLAB_API_TOKEN=<INSERT_TOKEN> -e DATA_DIR=/data -e CONFIG_DIR=/app -v <PATH_TO_DATA_DIR>:/data -v <PATH_TO_CONFIG_DIR>/config adamhf/rss-sync:latest
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
69
70
```

71
72
73
74
75
## Prometheus Metrics
Two metrics (above and beyond what are exposed by the Go Prometheus library) are exposed on :8080/metrics
* last_run_time - The time of the last feed checks, useful for creating alerts to check for successful runs.
* issues_created - The total number of issues created in Gitlab, useful to check for runaways.

76
77
78
79
80
81
82
83
84
## Example Issues
### GKE Release Notes
Feed URL: https://cloud.google.com/feeds/kubernetes-engine-release-notes.xml
![GKE Release Notes](screenshots/GKEReleaseNotes.png "GKE Release Notes")
### GKE Security Updates
Feed URL: https://cloud.google.com/feeds/kubernetes-engine-security-bulletins.xml
![GKE Security updates](screenshots/GKESecurityUpdate.png "GKE Security updates")


Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
85
## TODO
Adam Harrison-Fuller's avatar
Adam Harrison-Fuller committed
86
* Make the retroactive setting of the Gitlab creation time optional.