Skip to content

Commit

Permalink
tweak instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Barb Cutler authored and Barb Cutler committed Jun 13, 2024
1 parent d677596 commit 9862bb5
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 32 deletions.
21 changes: 11 additions & 10 deletions _docs/sysadmin/configuration/ansible_course_creation.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: Course Creation
title: Course Creation using Ansible
category: System Administrator > Configuration & Administration
---

# Course Creation using Ansible

Ansible is a powerful automation tool that can be used to manage configurations and automate the course creation process in Submitty.

## Prerequisites

This guide assumes that you are already following the Ansible installation guide for Submitty. If you have not yet installed Ansible or set up Submitty with Ansible, please refer to the [Ansible Installation Guide](/sysadmin/installation/ansible) before proceeding with course creation.
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

Expand All @@ -29,6 +25,11 @@ This guide assumes that you are already following the Ansible installation guide
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 Documentation](course_creation)
**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.
**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)
19 changes: 10 additions & 9 deletions _docs/sysadmin/configuration/ansible_term_creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@ title: Term Creation using Ansible
category: System Administrator > Configuration & Administration
---

# Term Creation using Ansible

Ansible is a powerful automation tool that can be used to manage configurations and automate the term creation process in Submitty.

## Prerequisites

This guide assumes that you are already following the Ansible installation guide for Submitty. If you have not yet installed Ansible or set up Submitty with Ansible, please refer to the [Ansible Installation Guide](/sysadmin/installation/ansible) before proceeding with term creation.
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

Expand All @@ -33,6 +29,11 @@ This guide assumes that you are already following the Ansible installation guide
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 Documentation](term_creation).
**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.
**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)
29 changes: 17 additions & 12 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,25 +18,26 @@ 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(`.setup/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
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.
**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

Expand Down Expand Up @@ -68,7 +69,6 @@ Getting Started:

```
cd .setup/ansible
```

Once you are in the `ansible` directory, you can proceed with the installation by running the
Expand All @@ -91,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)
2 changes: 1 addition & 1 deletion navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +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 Installation", "/sysadmin/installation/ansible", 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 Down

0 comments on commit 9862bb5

Please sign in to comment.