Skip to content

Commit 715fb9e

Browse files
[Documentation:Developer] Ansible Create Term & Course Docs (#610)
The Ansible Create Course and Create Term Documentation. This will allow for user to create a term and a course on their web server following an ansible install. --------- Co-authored-by: Cameron Peterson <[email protected]> Co-authored-by: Barb Cutler <Barb Cutler>
1 parent 9c7ecca commit 715fb9e

File tree

6 files changed

+105
-14
lines changed

6 files changed

+105
-14
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Course Creation using Ansible
3+
category: System Administrator > Configuration & Administration
4+
---
5+
6+
NOTE: This guide assumes that you have first created a Submitty server
7+
using Ansible following the
8+
[Installation using Ansible](/sysadmin/installation/ansible) instructions.
9+
10+
## Steps to Create a Course
11+
12+
1. Navigate to the ansible directory in your Submitty installation:
13+
14+
```
15+
cd .setup/ansible
16+
```
17+
18+
2. There is a playbook available named `submitty_course_creation.yml`. This playbook contains the necessary roles to create a new course in Submitty. You can edit this file to specify the details of the course you want to create.
19+
20+
3. Run the playbook using the following command:
21+
22+
```
23+
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml
24+
```
25+
26+
4. Once the process is complete, your new course should be available in Submitty.
27+
28+
**For a more detailed step-by-step guide on creating a course, you
29+
can refer to the [Course Creation](course_creation)
30+
instructions.
31+
32+
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_course_creation` role.
33+
34+
See also:
35+
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Term Creation using Ansible
3+
category: System Administrator > Configuration & Administration
4+
---
5+
6+
NOTE: This guide assumes that you have first created a Submitty server
7+
using Ansible following the
8+
[Installation using Ansible](/sysadmin/installation/ansible) instructions.
9+
10+
## Steps to Create a Term
11+
12+
1. Navigate to the `ansible directory` in your Submitty installation:
13+
14+
```
15+
cd .setup/asnible
16+
```
17+
18+
2. There is a playbook available named `submitty_course_creation.yml`. This playbook contains the necessary roles to create a new term in Submitty. You can edit this file to specify the details of the term you want to create.
19+
20+
**Remember: The term should be an abbreviated semester name like: `s24` . The start and end date must be formatted in mm/dd/yyyy format.
21+
22+
3. Run the playbook using the following command:
23+
24+
```
25+
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml
26+
```
27+
28+
This command will start the term creation process. Ansible will display the progress in the terminal.
29+
30+
4. Once the process is complete, your new term should be available in Submitty.
31+
32+
**For a more detailed step-by-step guide on creating a course, you
33+
can refer to the [Term Creation](term_creation) instructions.
34+
35+
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_term_creation` role.
36+
37+
38+
See also:
39+
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)

_docs/sysadmin/configuration/course_creation.md

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ redirect_from:
55
- /sysadmin/course_creation
66
---
77

8+
**Note**: If you are using Ansible for managing Submitty,
9+
you can follow these [instructions](ansible_course_creation) to create a course using Ansible.
10+
811

912
### UNIX Users and Groups
1013

_docs/sysadmin/configuration/term_creation.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ redirect_from:
55
- /sysadmin/course_creation
66
---
77

8+
**Note**: If you are using Ansible for managing Submitty,
9+
you can follow these [instructions](ansible_term_creation) to create a term using Ansible.
810

911
### Creating a term
1012
To create a term, you should use the script

_docs/sysadmin/installation/ansible.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Installing with Ansible
2+
title: Installation using Ansible
33
category: System Administrator > Installation
44
redirect_from:
55
---
66

7-
These are the instructions for install Submitty using Ansible.
7+
Ansible is a powerful automation tool that can be used to manage
8+
configurations and automate the term creation process in Submitty.
89

9-
Getting Started:
10-
11-
**Note**: We assume that you're installing Submitty on a dedicated machine.
10+
***Note**: We assume that you're installing Submitty server on a
11+
dedicated machine.*
1212

1313
1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os)
1414

@@ -18,24 +18,27 @@ Getting Started:
1818

1919
2. Install Ansible:
2020

21-
Installing Ansible on your local environment is required. Below is a link for more help.
22-
23-
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
21+
Installing Ansible on your local environment is required.
22+
See also: [Ansible Documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
2423

2524

2625
3. Edit Inventory and Add Server IP:
2726

2827
An example has been given to you in the inventory file. Update localhost with your server ip address.
2928
This will allow access to your web interface.
3029

31-
4. Edit playbook variables with your server properties(`ansible/playbooks/submitty_install.yml`):
30+
4. Edit playbook variables with your server properties, stored in this file:
31+
`.setup/ansible/playbooks/submitty_install.yml`
3232

33-
Note: Configure your playbook with your Submitty settings. See
34-
`ansible/roles/app_submitty/defaults/main.yml` for default installation parameters.
33+
Note: Configure your playbook with your Submitty settings. See:
34+
`.setup/ansible/roles/app_submitty/defaults/main.yml` for default installation parameters.
3535

3636
**Important**: Any variables defined in the playbook will take precedence over the default values.
3737
This allows for fine-tuning and customization of your Submitty installation.
3838

39+
**Reminder**: Ensure that the `submitty_version` variable in your playbook matches the version of
40+
Submitty you intend to install. This is crucial for the correct functioning of your installation.
41+
3942
5. SSL Configuration
4043

4144
Note: If you use SSL, follow steps to configure. If not, skip to step 6.
@@ -61,11 +64,11 @@ Getting Started:
6164

6265
6. Run Ansible Script
6366

64-
To initiate the installation process, first navigate to the 'ansible' directory.
67+
To initiate the installation process, first navigate to the '.setup/ansible' directory.
6568
Execute the following command:
6669

6770
```
68-
cd ansible
71+
cd .setup/ansible
6972
```
7073

7174
Once you are in the `ansible` directory, you can proceed with the installation by running the
@@ -77,7 +80,8 @@ Getting Started:
7780

7881
This command initiates the Ansible playbook, which orchestrates the comprehensive installation
7982
process for Submitty. For a detailed understanding of the installation steps, refer to
80-
`ansible/roles/app_submitty/tasks/main.yml`.
83+
`.setup/ansible/roles/app_submitty/tasks/main.yml`.
84+
8185

8286
7. Review Installation Log on VM
8387

@@ -87,3 +91,8 @@ Getting Started:
8791
8. Navigate to Web Interface
8892

8993
Navigate to your domain name in a web browser.
94+
95+
96+
See also:
97+
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)
98+
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)

navtreedata.js

+3
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ var NAVTREE =
145145
[ "Server OS", "/sysadmin/installation/server_os", null ],
146146
[ "Update GNU/Linux Server", "/sysadmin/installation/update_server", null ],
147147
[ "Update Submitty", "/sysadmin/installation/update_submitty", null ],
148+
[ "Ansible Server Installation", "/sysadmin/installation/ansible", null ],
148149
[ "Version Notes", "/sysadmin/installation/version_notes/index", [
149150
[ "Overview", "/sysadmin/installation/version_notes/index", null],
150151
[ "v23.12.02", "/sysadmin/installation/version_notes/v23.12.02", null ],
@@ -167,7 +168,9 @@ var NAVTREE =
167168
] ],
168169
[ "Configuration & Administration", "/sysadmin/configuration/course_creation", [
169170
[ "Term Creation", "/sysadmin/configuration/term_creation", null ],
171+
[ "Ansible Term Creation", "/sysadmin/configuration/ansible_term_creation", null ],
170172
[ "Course Creation", "/sysadmin/configuration/course_creation", null ],
173+
[ "Ansible Course Creation", "/sysadmin/configuration/ansible_course_creation", null ],
171174
[ "Setting up Version Control", "/sysadmin/configuration/version_control", null ],
172175
[ "SAML Authentication", "/sysadmin/configuration/saml_authentication", null ],
173176
[ "Email Configuration", "/sysadmin/configuration/email_configuration", null ],

0 commit comments

Comments
 (0)