You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Note**: The `-v /path/to/your/config:/etc/fedmsg.d/` option mounts your local configuration directory inside the container, allowing the containerized application to use your host system's configuration files.
66
-
67
47
### From Source
68
48
69
49
```bash
@@ -88,6 +68,8 @@ INITIALIZE=1 sync2jira
88
68
sync2jira
89
69
```
90
70
71
+
**Note**: Container images are also available as an alternative to native installation. See the [Usage](#usage) section for container deployment instructions.
72
+
91
73
## Configuration
92
74
93
75
Create a configuration file in the `fedmsg.d/` directory. Here's a basic example:
@@ -152,24 +134,49 @@ config = {
152
134
153
135
## Usage
154
136
155
-
### Container Deployment
137
+
### Sync2Jira Service
138
+
139
+
The main synchronization service that listens for GitHub events and creates/updates JIRA issues.
156
140
157
-
**Sync Page UI**
141
+
#### Native Installation
158
142
159
143
```bash
160
-
# Run the web interface for manual synchronization
144
+
# Run the service
145
+
sync2jira
146
+
147
+
# With initialization (sync all existing issues)
148
+
INITIALIZE=1 sync2jira
149
+
150
+
# Testing mode (dry run)
151
+
# Set testing: True in config file
152
+
sync2jira
153
+
```
154
+
155
+
#### Container Deployment
156
+
157
+
```bash
158
+
# Basic usage - run the sync service
161
159
docker run -v /path/to/your/config:/etc/fedmsg.d/ \
**Note**: The `-v /path/to/your/config:/etc/fedmsg.d/` option mounts your local configuration directory inside the container, allowing the containerized application to use your host system's configuration files.
173
+
174
+
### Sync Page UI
175
+
176
+
A web interface for manually triggering synchronization of specific repositories when needed.
169
177
170
-
The sync page is a separate web application that provides a UI for manually triggering synchronization.
178
+
#### Native Installation
171
179
172
-
**Running the sync page locally:**
173
180
```bash
174
181
# Navigate to the sync-page directory
175
182
cd sync-page
@@ -178,18 +185,32 @@ cd sync-page
178
185
python event-handler.py
179
186
```
180
187
188
+
#### Container Deployment
189
+
190
+
```bash
191
+
# Run the web interface for manual synchronization
192
+
docker run -v /path/to/your/config:/etc/fedmsg.d/ \
193
+
-p 5000:5000 \
194
+
-e GITHUB_TOKEN=your_token \
195
+
-e JIRA_TOKEN=your_jira_token \
196
+
quay.io/redhat-aqe/sync2jira:sync-page
197
+
```
198
+
181
199
**Access the interface:**
182
200
- Local development: `http://localhost:5000` (or whatever port Flask shows)
183
201
- Production: Configure according to your deployment environment
184
202
185
-
186
203
### Environment Variables
187
204
188
-
-`INITIALIZE`: Set to `1` to perform initial sync of all issues
189
-
-`FEDORA_MESSAGING_QUEUE`: Custom message queue name
205
+
The following environment variables can be used to configure both tools:
206
+
207
+
**Common Variables (used by both sync2jira and sync-page):**
190
208
-`GITHUB_TOKEN`: GitHub API token (can override config)
191
209
-`JIRA_TOKEN`: JIRA API token (can override config)
192
210
211
+
**Sync2Jira Service Only:**
212
+
-`INITIALIZE`: Set to `1` to perform initial sync of all issues
213
+
-`FEDORA_MESSAGING_QUEUE`: Custom message queue name
0 commit comments