Skip to content

Commit ef885a7

Browse files
authored
docs(okd): Add post-installation steps
1 parent e35ca69 commit ef885a7

File tree

1 file changed

+44
-3
lines changed

1 file changed

+44
-3
lines changed

docs/deployment-okd.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: deployment-okd
33
title: OKD Deployment
44
---
55

6+
## Deployment configuration
7+
68
Three deployments should be made:
79

810
- HackathonManager (seen below)
@@ -16,7 +18,7 @@ Each should share a common secret, containing all relevant environment variables
1618
- `REDIS_URL=redis://:password@redis:6379/`
1719
- All remaining environment variables from [Environment Variables](deployment-environment-variables.md)
1820

19-
## MySQL Deployment
21+
### MySQL Deployment
2022

2123
1. Set up a MySQL deployment from the standard OpenShift catalog.
2224
2. Copy the username/password/port/host/database name to the relevant parts of `DATABSE_URL` in the shared secret config
@@ -26,12 +28,12 @@ Each should share a common secret, containing all relevant environment variables
2628
mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
2729
```
2830

29-
## Redis Deployment
31+
### Redis Deployment
3032

3133
1. Set up a Redis deployment from the standard OpenShift catalog.
3234
2. Copy the password/port/host to the relevant parts of `REDIS_URL` in the shared secret config
3335

34-
## HackathonManager Deployment
36+
### HackathonManager Deployment
3537

3638
This consists of a pod with two containers: `web` and `sidekiq`. Both use the same built image; sidekiq runs with a custom command.
3739

@@ -130,3 +132,42 @@ spec:
130132
type: ImageChange
131133
- type: ConfigChange
132134
```
135+
136+
## Post-installation steps
137+
138+
1. Seed the database (schools, emails, etc) -- do this **before** you create your first user
139+
2. Apply as a hacker
140+
3. Manually promote your (first) account to an admin
141+
4. Configure your hackathon
142+
143+
### Seed the database
144+
145+
1. On the OKD website, navigate to the currently-running HackathonManager pod (Applications -> Pods -> Click the HM pod in the list)
146+
2. In the tab bar, click "Terminal"
147+
3. Once the terminal opens up, run the following:
148+
```bash
149+
bin/rails db:seed
150+
exit
151+
```
152+
153+
### Apply as a hacker
154+
155+
1. Open your hackathon's website, create an account, and complete an application
156+
2. Validate that you received a confirmation email (if you didn't, don't fix it now, but take note for later)
157+
158+
### Manually promote your account to admin status
159+
160+
1. On the OKD website, navigate to the currently-running HackathonManager pod (Applications -> Pods -> Click the HM pod in the list)
161+
2. In the tab bar, click "Terminal"
162+
3. Once the terminal opens up, run the following:
163+
```bash
164+
bin/rails c
165+
# Wait for the Rails console to start...
166+
User.find_by(email: "your-email@example.com").update_attribute(:role, :admin)
167+
exit
168+
exit
169+
```
170+
171+
### Configure your hackathon
172+
173+
1. Navigate to https://apply.your-hackathon.com/manage/configs and fill in/update all relevant values

0 commit comments

Comments
 (0)