Skip to content

[Documentation:Developer] Ansible Create Term & Course Docs #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 38 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
87ac41d
[Documentation:developer] Adding Ansible Script Process
ethanfordwork Mar 7, 2024
e659099
updating
ethanfordwork Mar 7, 2024
20e1168
updating
ethanfordwork Mar 7, 2024
25aa4fc
[Documentation:Developer] adding ansible script option
ethanfordwork Mar 11, 2024
2bcd735
[Documentation:Developer] Adding instructions
ethanfordwork Mar 11, 2024
bf96c71
working
ethanfordwork Mar 14, 2024
8499f9d
working
ethanfordwork Mar 14, 2024
bbe04d1
fixing documentation
ethanfordwork Mar 15, 2024
852bd2a
[Documentation:Developer] Add Ansible Install Script Documentation
ethanfordwork Apr 5, 2024
092453c
Merge branch 'Submitty:main' into main
ethanfordwork Apr 8, 2024
225e20a
Merge branch 'Submitty:main' into main
ethanfordwork Apr 10, 2024
3cfd6e5
[Documentation] Ansible Install Script
ethanfordwork Apr 18, 2024
e32a7de
adding ansible install instructions to index.md
ethanfordwork Apr 18, 2024
8a2640a
updating documentation for PR
ethanfordwork Apr 18, 2024
4a04672
[Documentation] Adding reminder submitty version
ethanfordwork Apr 28, 2024
e7a9a3b
updating directory names in documentation
ethanfordwork May 1, 2024
11d6cef
adding documentation for create course
ethanfordwork May 30, 2024
26021e2
updating documentation
ethanfordwork May 30, 2024
699d264
updating
ethanfordwork May 30, 2024
8373c1f
adding term documenatation
ethanfordwork May 30, 2024
3df4c28
updating course creation documentation
ethanfordwork May 30, 2024
b963424
[Documentation:Developer] Ansible Course Creation Documentation
ethanfordwork May 30, 2024
186e55d
updating term creation documentation
ethanfordwork May 31, 2024
9a37b7d
updating
ethanfordwork May 31, 2024
d224608
updating term creation script
ethanfordwork May 31, 2024
a3c8838
[Documentation:Developer] Ansible Create Course and Term Documentation
ethanfordwork Jun 5, 2024
1316d6e
making changes to directory and grammar
ethanfordwork Jun 6, 2024
ce63d6e
Merge branch 'main' into main
IDzyre Jun 7, 2024
6c161b5
fixing linking issues
ethanfordwork Jun 7, 2024
7187e0c
re fixing linking
ethanfordwork Jun 7, 2024
e1c3ee9
fixing linking issues removing md
ethanfordwork Jun 7, 2024
0250431
trying linking
ethanfordwork Jun 7, 2024
cee755b
fixing last linking issues
ethanfordwork Jun 7, 2024
b70bbce
last two linking issues
ethanfordwork Jun 7, 2024
1857be9
linking issues
ethanfordwork Jun 7, 2024
47172c9
removing redirect from new files
ethanfordwork Jun 7, 2024
d677596
adding ansible to navtreedata.js
ethanfordwork Jun 7, 2024
9862bb5
tweak instructions
Jun 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions _docs/sysadmin/configuration/ansible_course_creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Course Creation using Ansible
category: System Administrator > Configuration & Administration
---

NOTE: This guide assumes that you have first created a Submitty server
using Ansible following the
[Installation using Ansible](/sysadmin/installation/ansible) instructions.

## Steps to Create a Course

1. Navigate to the ansible directory in your Submitty installation:

```
cd .setup/ansible
```

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.

3. Run the playbook using the following command:

```
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml
```

4. Once the process is complete, your new course should be available in Submitty.

**For a more detailed step-by-step guide on creating a course, you
can refer to the [Course Creation](course_creation)
instructions.

**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.

See also:
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)
39 changes: 39 additions & 0 deletions _docs/sysadmin/configuration/ansible_term_creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Term Creation using Ansible
category: System Administrator > Configuration & Administration
---

NOTE: This guide assumes that you have first created a Submitty server
using Ansible following the
[Installation using Ansible](/sysadmin/installation/ansible) instructions.

## Steps to Create a Term

1. Navigate to the `ansible directory` in your Submitty installation:

```
cd .setup/asnible
```

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.

**Remember: The term should be an abbreviated semester name like: `s24` . The start and end date must be formatted in mm/dd/yyyy format.

3. Run the playbook using the following command:

```
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml
```

This command will start the term creation process. Ansible will display the progress in the terminal.

4. Once the process is complete, your new term should be available in Submitty.

**For a more detailed step-by-step guide on creating a course, you
can refer to the [Term Creation](term_creation) instructions.

**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.


See also:
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)
3 changes: 3 additions & 0 deletions _docs/sysadmin/configuration/course_creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ redirect_from:
- /sysadmin/course_creation
---

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


### UNIX Users and Groups

Expand Down
2 changes: 2 additions & 0 deletions _docs/sysadmin/configuration/term_creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ redirect_from:
- /sysadmin/course_creation
---

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

### Creating a term
To create a term, you should use the script
Expand Down
37 changes: 23 additions & 14 deletions _docs/sysadmin/installation/ansible.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Installing with Ansible
title: Installation using Ansible
category: System Administrator > Installation
redirect_from:
---

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

Getting Started:

**Note**: We assume that you're installing Submitty on a dedicated machine.
***Note**: We assume that you're installing Submitty server on a
dedicated machine.*

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

Expand All @@ -18,24 +18,27 @@ Getting Started:

2. Install Ansible:

Installing Ansible on your local environment is required. Below is a link for more help.

https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
Installing Ansible on your local environment is required.
See also: [Ansible Documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)


3. Edit Inventory and Add Server IP:

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

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

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

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

**Reminder**: Ensure that the `submitty_version` variable in your playbook matches the version of
Submitty you intend to install. This is crucial for the correct functioning of your installation.

5. SSL Configuration

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

6. Run Ansible Script

To initiate the installation process, first navigate to the 'ansible' directory.
To initiate the installation process, first navigate to the '.setup/ansible' directory.
Execute the following command:

```
cd ansible
cd .setup/ansible
```

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

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


7. Review Installation Log on VM

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

Navigate to your domain name in a web browser.


See also:
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)
3 changes: 3 additions & 0 deletions navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ var NAVTREE =
[ "Server OS", "/sysadmin/installation/server_os", null ],
[ "Update GNU/Linux Server", "/sysadmin/installation/update_server", null ],
[ "Update Submitty", "/sysadmin/installation/update_submitty", null ],
[ "Ansible Server Installation", "/sysadmin/installation/ansible", null ],
[ "Version Notes", "/sysadmin/installation/version_notes/index", [
[ "Overview", "/sysadmin/installation/version_notes/index", null],
[ "v23.12.02", "/sysadmin/installation/version_notes/v23.12.02", null ],
Expand All @@ -167,7 +168,9 @@ var NAVTREE =
] ],
[ "Configuration & Administration", "/sysadmin/configuration/course_creation", [
[ "Term Creation", "/sysadmin/configuration/term_creation", null ],
[ "Ansible Term Creation", "/sysadmin/configuration/ansible_term_creation", null ],
[ "Course Creation", "/sysadmin/configuration/course_creation", null ],
[ "Ansible Course Creation", "/sysadmin/configuration/ansible_course_creation", null ],
[ "Setting up Version Control", "/sysadmin/configuration/version_control", null ],
[ "SAML Authentication", "/sysadmin/configuration/saml_authentication", null ],
[ "Email Configuration", "/sysadmin/configuration/email_configuration", null ],
Expand Down
Loading