From 87ac41d08978fa8a57218ec11800f9a191fc781c Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:09:09 -0800 Subject: [PATCH 01/35] [Documentation:developer] Adding Ansible Script Process --- _docs/sysadmin/installation/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index d6006d40..cf2d8ede 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,6 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ _here_ }}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From e6590994f25902d52f531aead4f072a76fe7b9b9 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:36:37 -0800 Subject: [PATCH 02/35] updating --- _docs/sysadmin/installation/ansible_index.md | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 _docs/sysadmin/installation/ansible_index.md diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md new file mode 100644 index 00000000..7ef872f6 --- /dev/null +++ b/_docs/sysadmin/installation/ansible_index.md @@ -0,0 +1,25 @@ +--- +title: Overview +category: System Administrator > Installation +redirect_from: + - /developer/installation +--- + +These instructions will help guide you to installing Submitty onto a +server (whether on a dedicated machine or a VM). + +**Note**: We assume that you're installing Submitty on a dedicated machine. + +1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) + + Note: If you are duplicating an existing Submitty installation onto a new server, you should + synchronize `/etc/passwd`, `/etc/shadow`, `/etc/group`, and `/etc/gshadow` before installing + the rest of Submitty to avoid mismatched UIDs and GIDs of the Submitty users. + +2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) + +Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This + + + + From 20e116815dd153048b605fc0b2570c5efd55d6c3 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:53:04 -0800 Subject: [PATCH 03/35] updating --- _docs/sysadmin/installation/ansible_index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 7ef872f6..6ef9b27d 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -18,7 +18,9 @@ server (whether on a dedicated machine or a VM). 2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) -Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This + Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + +3. [] From 25aa4fcb0de8f4545e1804c70e1cb2e1ada31d72 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Mon, 11 Mar 2024 13:45:36 -0700 Subject: [PATCH 04/35] [Documentation:Developer] adding ansible script option --- _docs/sysadmin/installation/ansible_index.md | 11 +++++++++-- _docs/sysadmin/installation/index.md | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 6ef9b27d..fdcf61f7 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -18,10 +18,17 @@ server (whether on a dedicated machine or a VM). 2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) - Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + Note: Your edits should match your dedicated machine(or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. -3. [] +3. [Run ansible script] + In the terminal, run the command: + Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml +This ansible command will run the entire Submitty install process step by step. See (ansible/roles/app_submitty/tasks/main.yml) for more information on the Install process. + +4. [Check Install Log] + Navigate to (/usr/local/submitty/install.log) on your machine(or VM) to see the output of the install process. + diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index cf2d8ede..48c1d4fd 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ _here_ }}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ https://github.com/submitty.github.io/blob/main/_docs/sysadmin/installation/ansible_index.md}}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From 2bcd73577b52bd3b90dea20d47ca02f75c81963d Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Mon, 11 Mar 2024 16:42:14 -0700 Subject: [PATCH 05/35] [Documentation:Developer] Adding instructions --- _docs/sysadmin/installation/ansible_index.md | 43 +++++++++++++++----- _docs/sysadmin/installation/index.md | 2 +- 2 files changed, 34 insertions(+), 11 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index fdcf61f7..0cde4fcb 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -1,12 +1,18 @@ --- -title: Overview +title: Installing with Ansible category: System Administrator > Installation redirect_from: - /developer/installation --- -These instructions will help guide you to installing Submitty onto a -server (whether on a dedicated machine or a VM). +These are the ansible install instructions that will help guide you to installing Submitty onto a +server. + +Things you need before starting: +Need a machine with ansible - find link how to install ansible on any machine + + + **Note**: We assume that you're installing Submitty on a dedicated machine. @@ -16,19 +22,36 @@ server (whether on a dedicated machine or a VM). synchronize `/etc/passwd`, `/etc/shadow`, `/etc/group`, and `/etc/gshadow` before installing the rest of Submitty to avoid mismatched UIDs and GIDs of the Submitty users. -2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) +2. Edit inventory and add server IP + + Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + +3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml) - Note: Your edits should match your dedicated machine(or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -3. [Run ansible script] + + +ssl + +3. Run ansible script In the terminal, run the command: - Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml -This ansible command will run the entire Submitty install process step by step. See (ansible/roles/app_submitty/tasks/main.yml) for more information on the Install process. + ``` + Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml + ``` + + This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. + +4. Check Install Log -4. [Check Install Log] - Navigate to (/usr/local/submitty/install.log) on your machine(or VM) to see the output of the install process. + Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. +access +THings you need +Clean ubuntu install +a machine that runs ansible (probably not the ubuntu vm) +need a machine that runs ansible and can connect diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 48c1d4fd..204e9bdf 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ https://github.com/submitty.github.io/blob/main/_docs/sysadmin/installation/ansible_index.md}}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions {{here}}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From bf96c71f67f3398513c3def83abb1bbdad46843b Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 14 Mar 2024 14:16:57 -0700 Subject: [PATCH 06/35] working --- _docs/sysadmin/installation/ansible_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 0cde4fcb..60673d10 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -22,11 +22,11 @@ Need a machine with ansible - find link how to install ansible on any machine synchronize `/etc/passwd`, `/etc/shadow`, `/etc/group`, and `/etc/gshadow` before installing the rest of Submitty to avoid mismatched UIDs and GIDs of the Submitty users. -2. Edit inventory and add server IP +2. Edit inventory and add server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. -3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml) +3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. From 8499f9d45883cff5d3e90a2f9b8ebd5d99338235 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 14 Mar 2024 14:17:23 -0700 Subject: [PATCH 07/35] working --- _docs/sysadmin/installation/ansible_index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 60673d10..9b72ab98 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -22,6 +22,11 @@ Need a machine with ansible - find link how to install ansible on any machine synchronize `/etc/passwd`, `/etc/shadow`, `/etc/group`, and `/etc/gshadow` before installing the rest of Submitty to avoid mismatched UIDs and GIDs of the Submitty users. +2. Install Ansible: + + + + 2. Edit inventory and add server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. From bbe04d1e560e21e49bf37b12cab5c68563474118 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 15 Mar 2024 15:54:03 -0700 Subject: [PATCH 08/35] fixing documentation --- _docs/sysadmin/installation/ansible_index.md | 31 ++++++++------------ 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 9b72ab98..ccc0e303 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -5,14 +5,9 @@ redirect_from: - /developer/installation --- -These are the ansible install instructions that will help guide you to installing Submitty onto a -server. - -Things you need before starting: -Need a machine with ansible - find link how to install ansible on any machine - - +These are the ansible install instructions that will help guide you to installing Submitty onto a server. +Getting Started: **Note**: We assume that you're installing Submitty on a dedicated machine. @@ -24,22 +19,24 @@ Need a machine with ansible - find link how to install ansible on any machine 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 -2. Edit inventory and add server IP: +3. Edit Inventory and Add Server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. -3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): +4. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -ssl +**ssl** -3. Run ansible script +6. Run Ansible Script In the terminal, run the command: @@ -49,14 +46,10 @@ ssl This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. -4. Check Install Log +7. Check Install Log Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. -access - +8. Navigate to Web Server -THings you need -Clean ubuntu install -a machine that runs ansible (probably not the ubuntu vm) -need a machine that runs ansible and can connect + Navigate to your servers IP in a web browser. From 852bd2a3675e8b8d0c2466ab59f93d4f4ff10420 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 5 Apr 2024 13:39:16 -0700 Subject: [PATCH 09/35] [Documentation:Developer] Add Ansible Install Script Documentation --- _docs/sysadmin/installation/ansible_index.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index ccc0e303..8fdb1e57 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -26,15 +26,28 @@ Getting Started: 3. Edit Inventory and Add Server IP: - Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + Replace 'submitty_ip' with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. 4. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. +5. Configure SSL + Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. -**ssl** + To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. + + Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). + + Then, update the `ansible/roles/app_submitty/defaults/main.yml` file with the paths to your certificate and key. The relevant lines might look something like this: + + ```yaml + ssl_certificate: /etc/ssl/certs/mycert.pem + ssl_certificate_key: /etc/ssl/private/mykey.pem + ``` + + Save your changes and proceed to run the Ansible script. 6. Run Ansible Script @@ -44,7 +57,7 @@ Getting Started: Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` - This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. +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`. 7. Check Install Log From 3cfd6e5e703324ec628bcc0d5cb367036e40240b Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 10:43:05 -0700 Subject: [PATCH 10/35] [Documentation] Ansible Install Script --- _docs/sysadmin/installation/ansible_index.md | 35 ++++++++++++-------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 8fdb1e57..3f7bcaff 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -26,13 +26,17 @@ Getting Started: 3. Edit Inventory and Add Server IP: - Replace 'submitty_ip' with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + 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 default playbook to match your server(ansible/playbooks/submitty_install.yml): +4. Edit playbook variables with your server properties(ansible/playbooks/submitty_install.yml): - Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. + Note: Configure your playbook with your Submitty settings. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -5. Configure SSL + **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. + +5. SSL COnfiguration + + Note: If you use SSL, follow steps to configure. If not, skip to step 6. Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. @@ -40,29 +44,34 @@ Getting Started: Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). - Then, update the `ansible/roles/app_submitty/defaults/main.yml` file with the paths to your certificate and key. The relevant lines might look something like this: + Then, update your server's SSL configuration file with the paths to your certificate and key. The relevant lines might look something like this: - ```yaml - ssl_certificate: /etc/ssl/certs/mycert.pem - ssl_certificate_key: /etc/ssl/private/mykey.pem + ```bash + SSLCertificateFile /etc/ssl/certs/mycert.pem + SSLCertificateKeyFile /etc/ssl/private/mykey.pem ``` Save your changes and proceed to run the Ansible script. 6. Run Ansible Script - In the terminal, run the command: + To initiate the installation process, first navigate to the 'ansible' directory, then the install directory. You can execute the following command: + ``` + cd ansible + ``` + + Once you are in the `ansible` directory, you can proceed with the installation by running the Ansible playbook: ``` - Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml + ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` 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`. -7. Check Install Log +7. Review Installation Log on VM Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. -8. Navigate to Web Server +8. Navigate to Web Interface - Navigate to your servers IP in a web browser. + Navigate to your domain name in a web browser. From e32a7de1b7db2b1c44f12685e1183dc785a8c762 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 10:46:50 -0700 Subject: [PATCH 11/35] adding ansible install instructions to index.md --- _docs/sysadmin/installation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 204e9bdf..49bfd075 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions {{here}}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions in ansible_index.md. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From 8a2640afff57908fffac1535b362c3a8c17d813c Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 11:41:35 -0700 Subject: [PATCH 12/35] updating documentation for PR --- .../{ansible_index.md => ansible.md} | 46 ++++++++++++------- _docs/sysadmin/installation/index.md | 5 +- 2 files changed, 33 insertions(+), 18 deletions(-) rename _docs/sysadmin/installation/{ansible_index.md => ansible.md} (56%) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible.md similarity index 56% rename from _docs/sysadmin/installation/ansible_index.md rename to _docs/sysadmin/installation/ansible.md index 3f7bcaff..10ef6baa 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible.md @@ -2,10 +2,9 @@ title: Installing with Ansible category: System Administrator > Installation redirect_from: - - /developer/installation --- -These are the ansible install instructions that will help guide you to installing Submitty onto a server. +These are the instructions for install Submitty using Ansible. Getting Started: @@ -19,34 +18,41 @@ Getting Started: 2. Install Ansible: - Installing ansible on your local environment is required. Below is a link for more help. + 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 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. + 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(`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 + `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. + **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. -5. SSL COnfiguration +5. SSL Configuration Note: If you use SSL, follow steps to configure. If not, skip to step 6. - Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. + Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between + networked computers. It's necessary for secure data transmission, such as user login credentials. - To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. + To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can + be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. - Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). + Once you have your certificate and key, place them in the appropriate directory (usually + `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). - Then, update your server's SSL configuration file with the paths to your certificate and key. The relevant lines might look something like this: + Then, update your server's SSL configuration file with the paths to your certificate and key. + The relevant lines might look something like this: - ```bash + ``` SSLCertificateFile /etc/ssl/certs/mycert.pem SSLCertificateKeyFile /etc/ssl/private/mykey.pem ``` @@ -55,22 +61,28 @@ Getting Started: 6. Run Ansible Script - To initiate the installation process, first navigate to the 'ansible' directory, then the install directory. You can execute the following command: + To initiate the installation process, first navigate to the 'ansible' directory. + Execute the following command: + ``` cd ansible ``` - Once you are in the `ansible` directory, you can proceed with the installation by running the Ansible playbook: + Once you are in the `ansible` directory, you can proceed with the installation by running the + Ansible playbook: ``` ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` -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`. + 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`. 7. Review Installation Log on VM - Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. + Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the + install process. 8. Navigate to Web Interface diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 49bfd075..26203d87 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,10 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions in ansible_index.md. +We have two methods for installing Submitty. The first method is running the bootstrap +script which follows the set of instructions listed below. The second installation method uses Ansible. +You can use these [instructions](/sysadmin/installation/ansible). + 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From 4a046720f79281b5c61d2a385cba17f03ed0c5a5 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Sun, 28 Apr 2024 14:43:25 -0700 Subject: [PATCH 13/35] [Documentation] Adding reminder submitty version --- _docs/sysadmin/installation/ansible.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_docs/sysadmin/installation/ansible.md b/_docs/sysadmin/installation/ansible.md index 10ef6baa..cba17d4a 100644 --- a/_docs/sysadmin/installation/ansible.md +++ b/_docs/sysadmin/installation/ansible.md @@ -36,6 +36,9 @@ Getting Started: **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. From e7a9a3b6afdcbff53e43a73d893c9b20d89a9239 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Wed, 1 May 2024 13:37:31 -0700 Subject: [PATCH 14/35] updating directory names in documentation --- _docs/sysadmin/installation/ansible.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs/sysadmin/installation/ansible.md b/_docs/sysadmin/installation/ansible.md index cba17d4a..73675ae7 100644 --- a/_docs/sysadmin/installation/ansible.md +++ b/_docs/sysadmin/installation/ansible.md @@ -28,10 +28,10 @@ Getting Started: 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(`.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. + `.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. @@ -64,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 @@ -80,7 +80,7 @@ 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 From 11d6cef030b3fed9522e0141de9235b1496aa167 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 11:15:10 -0700 Subject: [PATCH 15/35] adding documentation for create course --- .../configuration/ansible_course_creation.md | 35 +++++++++++++++++++ .../configuration/ansible_term_creation.md | 0 2 files changed, 35 insertions(+) create mode 100644 _docs/sysadmin/configuration/ansible_course_creation.md create mode 100644 _docs/sysadmin/configuration/ansible_term_creation.md diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md new file mode 100644 index 00000000..63172cd7 --- /dev/null +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -0,0 +1,35 @@ +--- +title: Course Creation +category: System Administrator > Configuration & Administration +redirect_from: + - /sysadmin/ansible_course_creation +--- + +# 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 + +Before you begin, ensure that you have installed Ansible on your machine. If not, you can install it using the following command: + +```bash +sudo apt-get install ansible + +Steps to Create a Course + + 1. Navigate to the ansible directory in your Submitty installation: + + ``` + cd /path/to/submitty/ansible + ``` + + 2. There is a playbook available named create_course.yml. This playbook contains the necessary tasks 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 create_course.yml + ``` + + 4. Once the process is complete, your new course should be available in Submitty. diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md new file mode 100644 index 00000000..e69de29b From 26021e2dc4887b8fb9ef936f5f80b85c082eed6b Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 11:17:38 -0700 Subject: [PATCH 16/35] updating documentation --- _docs/sysadmin/configuration/ansible_course_creation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 63172cd7..be912c16 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -15,6 +15,7 @@ Before you begin, ensure that you have installed Ansible on your machine. If not ```bash sudo apt-get install ansible +``` Steps to Create a Course From 699d264e772d06d8e8ea7c73cea94e3d91c21024 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 11:19:35 -0700 Subject: [PATCH 17/35] updating --- .../configuration/ansible_course_creation.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index be912c16..6888b321 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -17,20 +17,20 @@ Before you begin, ensure that you have installed Ansible on your machine. If not sudo apt-get install ansible ``` -Steps to Create a Course +## Steps to Create a Course - 1. Navigate to the ansible directory in your Submitty installation: +1. Navigate to the ansible directory in your Submitty installation: - ``` - cd /path/to/submitty/ansible - ``` + ``` + cd /path/to/submitty/ansible + ``` - 2. There is a playbook available named create_course.yml. This playbook contains the necessary tasks to create a new course in Submitty. You can edit this file to specify the details of the course you want to create. +2. There is a playbook available named create_course.yml. This playbook contains the necessary tasks 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: +3. Run the playbook using the following command: - ``` - ansible-playbook create_course.yml - ``` + ``` + ansible-playbook create_course.yml + ``` - 4. Once the process is complete, your new course should be available in Submitty. +4. Once the process is complete, your new course should be available in Submitty. From 8373c1f1f47ce4a72dcfa86808cb5f9f23cf2f95 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 13:46:39 -0700 Subject: [PATCH 18/35] adding term documenatation --- .../configuration/ansible_course_creation.md | 4 +- .../configuration/ansible_term_creation.md | 39 +++++++++++++++++++ 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 6888b321..ca1846fa 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -22,7 +22,7 @@ sudo apt-get install ansible 1. Navigate to the ansible directory in your Submitty installation: ``` - cd /path/to/submitty/ansible + cd /.setup/ansible ``` 2. There is a playbook available named create_course.yml. This playbook contains the necessary tasks to create a new course in Submitty. You can edit this file to specify the details of the course you want to create. @@ -30,7 +30,7 @@ sudo apt-get install ansible 3. Run the playbook using the following command: ``` - ansible-playbook create_course.yml + ansible-playbook -i inventory/submitty playbooks/create_course.yml ``` 4. Once the process is complete, your new course should be available in Submitty. diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index e69de29b..ac6af02f 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -0,0 +1,39 @@ +--- +title: Term Creation using Ansible +category: System Administrator > Configuration & Administration +redirect_from: + - /sysadmin/ansible_term_creation +--- + +# 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 + +Before you begin, ensure that you have installed Ansible on your machine. If not, you can install it using the following command: + +```bash +sudo apt-get install ansible +``` + +## 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. + +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. + +** Remember, the `submitty_course_creation.yml` playbook can be customized to suit your needs. You can specify different parameters for the term such as the term name, start date, end date, etc. \ No newline at end of file From 3df4c28a94609252cc1fe88206a6ee34c5ea994f Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 13:49:13 -0700 Subject: [PATCH 19/35] updating course creation documentation --- _docs/sysadmin/configuration/ansible_course_creation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index ca1846fa..173e1c04 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -30,7 +30,7 @@ sudo apt-get install ansible 3. Run the playbook using the following command: ``` - ansible-playbook -i inventory/submitty playbooks/create_course.yml + ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml ``` 4. Once the process is complete, your new course should be available in Submitty. From b963424dbdb7bbc1b0f14c129db7523b9df0670d Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 14:12:12 -0700 Subject: [PATCH 20/35] [Documentation:Developer] Ansible Course Creation Documentation --- _docs/sysadmin/configuration/ansible_course_creation.md | 6 +++++- _docs/sysadmin/configuration/ansible_term_creation.md | 9 ++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 173e1c04..b4d74408 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -25,7 +25,7 @@ sudo apt-get install ansible cd /.setup/ansible ``` -2. There is a playbook available named create_course.yml. This playbook contains the necessary tasks to create a new course in Submitty. You can edit this file to specify the details of the course you want to create. +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: @@ -34,3 +34,7 @@ sudo apt-get install ansible ``` 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.md). + +**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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index ac6af02f..adaa135e 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -24,16 +24,19 @@ sudo apt-get install ansible 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. +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. + 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. -** Remember, the `submitty_course_creation.yml` playbook can be customized to suit your needs. You can specify different parameters for the term such as the term name, start date, end date, etc. \ No newline at end of file +**For a more detailed step-by-step guide on creating a course, you can refer to the [Term Creation Documentation](term_creation.md). + +**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. \ No newline at end of file From 186e55d5d5f9d678c27d22f0a3996232157b5596 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 17:27:18 -0700 Subject: [PATCH 21/35] updating term creation documentation --- .../sysadmin/configuration/ansible_course_creation.md | 2 +- _docs/sysadmin/configuration/ansible_term_creation.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index b4d74408..76b0cbb0 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -22,7 +22,7 @@ sudo apt-get install ansible 1. Navigate to the ansible directory in your Submitty installation: ``` - cd /.setup/ansible + 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. diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index adaa135e..8c3d3bd8 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -21,7 +21,7 @@ sudo apt-get install ansible 1. Navigate to the `ansible directory` in your Submitty installation: ``` -cd /.setup/asnible +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. @@ -29,11 +29,11 @@ cd /.setup/asnible **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 -``` + ``` + 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. +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. From 9a37b7d8d15d44e2dd615b1c40617ed7a58b20ce Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 17:27:58 -0700 Subject: [PATCH 22/35] updating --- _docs/sysadmin/configuration/ansible_term_creation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 8c3d3bd8..e139fbd9 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -27,11 +27,12 @@ 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 - ``` + ``` +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. From d224608335b9e23589acb0d7172e06c03bfc0dd9 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 30 May 2024 17:28:34 -0700 Subject: [PATCH 23/35] updating term creation script --- _docs/sysadmin/configuration/ansible_term_creation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index e139fbd9..0b331c72 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -26,7 +26,7 @@ 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. + **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: @@ -34,7 +34,7 @@ cd .setup/asnible 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. + 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. From a3c88383d743a5ccef7695da6fab8e3b14b91b36 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Wed, 5 Jun 2024 16:46:30 -0700 Subject: [PATCH 24/35] [Documentation:Developer] Ansible Create Course and Term Documentation --- .../configuration/ansible_course_creation.md | 10 +++----- .../configuration/ansible_term_creation.md | 23 ++++++++----------- .../sysadmin/configuration/course_creation.md | 3 +++ _docs/sysadmin/configuration/term_creation.md | 2 ++ 4 files changed, 18 insertions(+), 20 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 76b0cbb0..f9ac2b99 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,11 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## Prerequisites -Before you begin, ensure that you have installed Ansible on your machine. If not, you can install it using the following command: - -```bash -sudo apt-get install ansible -``` +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.md) before proceeding with course creation. ## Steps to Create a Course @@ -35,6 +31,6 @@ sudo apt-get install ansible 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.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](course_creation.md). -**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. \ No newline at end of file + **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 0b331c72..76358db4 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,18 +11,15 @@ Ansible is a powerful automation tool that can be used to manage configurations ## Prerequisites -Before you begin, ensure that you have installed Ansible on your machine. If not, you can install it using the following command: - -```bash -sudo apt-get install ansible -``` +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.md) before proceeding with term creation. ## Steps to Create a Term + 1. Navigate to the `ansible directory` in your Submitty installation: -``` -cd .setup/asnible -``` + ``` + 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. @@ -30,14 +27,14 @@ cd .setup/asnible 3. Run the playbook using the following command: - ``` -ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml -``` + ``` + 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 Documentation](term_creation.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Term Creation Documentation](term_creation.md). -**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. \ No newline at end of file + **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/course_creation.md b/_docs/sysadmin/configuration/course_creation.md index 06fe3b3a..2279cd26 100644 --- a/_docs/sysadmin/configuration/course_creation.md +++ b/_docs/sysadmin/configuration/course_creation.md @@ -5,6 +5,9 @@ redirect_from: - /sysadmin/course_creation --- +**Note**: If you are using Ansible for managing Submitty, +you can follow these [instructions](/_docs/sysadmin/configuration/ansible_course_creation.md) to create a course using Ansible. + ### UNIX Users and Groups diff --git a/_docs/sysadmin/configuration/term_creation.md b/_docs/sysadmin/configuration/term_creation.md index 25352add..47417935 100644 --- a/_docs/sysadmin/configuration/term_creation.md +++ b/_docs/sysadmin/configuration/term_creation.md @@ -5,6 +5,8 @@ redirect_from: - /sysadmin/course_creation --- +**Note**: If you are using Ansible for managing Submitty, +you can follow these [instructions](/_docs/sysadmin/configuration/ansible_term_creation.md) to create a term using Ansible. ### Creating a term To create a term, you should use the script From 1316d6ef1724272c94f41e14d915869af11339fb Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 6 Jun 2024 16:32:07 -0700 Subject: [PATCH 25/35] making changes to directory and grammar --- _docs/sysadmin/configuration/ansible_course_creation.md | 4 ++-- _docs/sysadmin/configuration/ansible_term_creation.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index f9ac2b99..d1792e9b 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with course creation. +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](/_docs/sysadmin/installation/ansible.md) before proceeding with course creation. ## Steps to Create a Course @@ -33,4 +33,4 @@ This guide assumes that you are already following the Ansible installation guide **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](course_creation.md). - **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. \ No newline at end of file + **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 76358db4..7cd14873 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with term creation. +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](/_docs/sysadmin/installation/ansible.md) before proceeding with term creation. ## Steps to Create a Term @@ -23,7 +23,7 @@ This guide assumes that you are already following the Ansible installation guide 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. + **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: From 6c161b5d76376d17f64a1f228e56619367accffe Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:07:39 -0700 Subject: [PATCH 26/35] fixing linking issues --- _docs/sysadmin/configuration/ansible_course_creation.md | 4 ++-- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index d1792e9b..7c1bb096 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible.md) before proceeding with course creation. +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.md) before proceeding with course creation. ## Steps to Create a Course @@ -31,6 +31,6 @@ 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.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](/sysadmin/configuration/course_creation.md). **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 7cd14873..d1d113ac 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible.md) before proceeding with term creation. +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.md) before proceeding with term creation. ## Steps to Create a Term From 7187e0c72f5f20cf0baba902b7dc974cae524ff5 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:15:38 -0700 Subject: [PATCH 27/35] re fixing linking --- _docs/sysadmin/configuration/ansible_course_creation.md | 4 ++-- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- _docs/sysadmin/configuration/course_creation.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 7c1bb096..c5613bd6 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with course creation. +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](_docs/sysadmin/installation/ansible.md) before proceeding with course creation. ## Steps to Create a Course @@ -31,6 +31,6 @@ 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](/sysadmin/configuration/course_creation.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](sysadmin/configuration/course_creation.md). **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index d1d113ac..60168475 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with term creation. +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.md) before proceeding with term creation. ## Steps to Create a Term diff --git a/_docs/sysadmin/configuration/course_creation.md b/_docs/sysadmin/configuration/course_creation.md index 2279cd26..182205f7 100644 --- a/_docs/sysadmin/configuration/course_creation.md +++ b/_docs/sysadmin/configuration/course_creation.md @@ -6,7 +6,7 @@ redirect_from: --- **Note**: If you are using Ansible for managing Submitty, -you can follow these [instructions](/_docs/sysadmin/configuration/ansible_course_creation.md) to create a course using Ansible. +you can follow these [instructions](_docs/sysadmin/configuration/ansible_course_creation.md) to create a course using Ansible. ### UNIX Users and Groups From e1c3ee977b801ed64c7ec220e121f0842a89a513 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:25:53 -0700 Subject: [PATCH 28/35] fixing linking issues removing md --- _docs/sysadmin/configuration/ansible_course_creation.md | 4 ++-- _docs/sysadmin/configuration/ansible_term_creation.md | 4 ++-- _docs/sysadmin/configuration/course_creation.md | 2 +- _docs/sysadmin/configuration/term_creation.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index c5613bd6..98139b91 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](_docs/sysadmin/installation/ansible.md) before proceeding with course creation. +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](/_docs/sysadmin/installation/ansible) before proceeding with course creation. ## Steps to Create a Course @@ -31,6 +31,6 @@ 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](sysadmin/configuration/course_creation.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](/_docs/sysadmin/configuration/course_creation) **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 60168475..bcd5a17a 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with term creation. +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](/_docs/sysadmin/installation/ansible) before proceeding with term creation. ## Steps to Create a Term @@ -35,6 +35,6 @@ 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.md). + **For a more detailed step-by-step guide on creating a course, you can refer to the [Term Creation Documentation](term_creation). **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/course_creation.md b/_docs/sysadmin/configuration/course_creation.md index 182205f7..692743d9 100644 --- a/_docs/sysadmin/configuration/course_creation.md +++ b/_docs/sysadmin/configuration/course_creation.md @@ -6,7 +6,7 @@ redirect_from: --- **Note**: If you are using Ansible for managing Submitty, -you can follow these [instructions](_docs/sysadmin/configuration/ansible_course_creation.md) to create a course using Ansible. +you can follow these [instructions](/_docs/sysadmin/configuration/ansible_course_creation) to create a course using Ansible. ### UNIX Users and Groups diff --git a/_docs/sysadmin/configuration/term_creation.md b/_docs/sysadmin/configuration/term_creation.md index 47417935..87567c20 100644 --- a/_docs/sysadmin/configuration/term_creation.md +++ b/_docs/sysadmin/configuration/term_creation.md @@ -6,7 +6,7 @@ redirect_from: --- **Note**: If you are using Ansible for managing Submitty, -you can follow these [instructions](/_docs/sysadmin/configuration/ansible_term_creation.md) to create a term using Ansible. +you can follow these [instructions](/_docs/sysadmin/configuration/ansible_term_creation) to create a term using Ansible. ### Creating a term To create a term, you should use the script From 02504314a8c9543f7a21e55390738e96e1f47679 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:32:03 -0700 Subject: [PATCH 29/35] trying linking --- _docs/sysadmin/configuration/ansible_course_creation.md | 4 ++-- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- _docs/sysadmin/configuration/course_creation.md | 2 +- _docs/sysadmin/configuration/term_creation.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 98139b91..68e8bec1 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible) before proceeding with course creation. +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](installation/ansible) before proceeding with course creation. ## Steps to Create a Course @@ -31,6 +31,6 @@ 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](/_docs/sysadmin/configuration/course_creation) + **For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](course_creation) **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. \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index bcd5a17a..b6dc993a 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible) before proceeding with term creation. +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.md) before proceeding with term creation. ## Steps to Create a Term diff --git a/_docs/sysadmin/configuration/course_creation.md b/_docs/sysadmin/configuration/course_creation.md index 692743d9..a092ef3d 100644 --- a/_docs/sysadmin/configuration/course_creation.md +++ b/_docs/sysadmin/configuration/course_creation.md @@ -6,7 +6,7 @@ redirect_from: --- **Note**: If you are using Ansible for managing Submitty, -you can follow these [instructions](/_docs/sysadmin/configuration/ansible_course_creation) to create a course using Ansible. +you can follow these [instructions](ansible_course_creation) to create a course using Ansible. ### UNIX Users and Groups diff --git a/_docs/sysadmin/configuration/term_creation.md b/_docs/sysadmin/configuration/term_creation.md index 87567c20..881eeaeb 100644 --- a/_docs/sysadmin/configuration/term_creation.md +++ b/_docs/sysadmin/configuration/term_creation.md @@ -6,7 +6,7 @@ redirect_from: --- **Note**: If you are using Ansible for managing Submitty, -you can follow these [instructions](/_docs/sysadmin/configuration/ansible_term_creation) to create a term using Ansible. +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 From cee755b9a0010f5166b951ffda0cfec43755d62a Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:36:00 -0700 Subject: [PATCH 30/35] fixing last linking issues --- _docs/sysadmin/configuration/ansible_course_creation.md | 2 +- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 68e8bec1..e9b8d85f 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](installation/ansible) before proceeding with course creation. +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](/_docs/sysadmin/installation/ansible) before proceeding with course creation. ## Steps to Create a Course diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index b6dc993a..bcd5a17a 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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.md) before proceeding with term creation. +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](/_docs/sysadmin/installation/ansible) before proceeding with term creation. ## Steps to Create a Term From b70bbce6f21a82be8c7b6035d7d428c0d7551d7d Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:37:54 -0700 Subject: [PATCH 31/35] last two linking issues --- _docs/sysadmin/configuration/ansible_course_creation.md | 2 +- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index e9b8d85f..8d6a55a3 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible) before proceeding with course creation. +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. ## Steps to Create a Course diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index bcd5a17a..335b73b3 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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](/_docs/sysadmin/installation/ansible) before proceeding with term creation. +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. ## Steps to Create a Term From 1857be98ec109303652f1a892039663ae9b60eec Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 13:39:11 -0700 Subject: [PATCH 32/35] linking issues --- _docs/sysadmin/configuration/ansible_course_creation.md | 2 +- _docs/sysadmin/configuration/ansible_term_creation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 8d6a55a3..826aac54 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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. +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. ## Steps to Create a Course diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 335b73b3..adf62cb9 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -11,7 +11,7 @@ Ansible is a powerful automation tool that can be used to manage configurations ## 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. +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. ## Steps to Create a Term From 47172c9501b669ec3b3686886f428b8ead0f12f9 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 15:38:38 -0700 Subject: [PATCH 33/35] removing redirect from new files --- _docs/sysadmin/configuration/ansible_course_creation.md | 2 -- _docs/sysadmin/configuration/ansible_term_creation.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index 826aac54..c83980d1 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -1,8 +1,6 @@ --- title: Course Creation category: System Administrator > Configuration & Administration -redirect_from: - - /sysadmin/ansible_course_creation --- # Course Creation using Ansible diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index adf62cb9..45c7c7b2 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -1,8 +1,6 @@ --- title: Term Creation using Ansible category: System Administrator > Configuration & Administration -redirect_from: - - /sysadmin/ansible_term_creation --- # Term Creation using Ansible From d6775960005c3d2cb82b8d589d7f82ad22560403 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 7 Jun 2024 15:51:23 -0700 Subject: [PATCH 34/35] adding ansible to navtreedata.js --- navtreedata.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/navtreedata.js b/navtreedata.js index ffbe8bc4..39e7bfa2 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -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 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 ], @@ -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 ], From 9862bb50c052f3b209a1b1f23a6b62c4c8b802c9 Mon Sep 17 00:00:00 2001 From: Barb Cutler Date: Thu, 13 Jun 2024 13:02:42 -0400 Subject: [PATCH 35/35] tweak instructions --- .../configuration/ansible_course_creation.md | 21 +++++++------- .../configuration/ansible_term_creation.md | 19 ++++++------ _docs/sysadmin/installation/ansible.md | 29 +++++++++++-------- navtreedata.js | 2 +- 4 files changed, 39 insertions(+), 32 deletions(-) diff --git a/_docs/sysadmin/configuration/ansible_course_creation.md b/_docs/sysadmin/configuration/ansible_course_creation.md index c83980d1..3230411a 100644 --- a/_docs/sysadmin/configuration/ansible_course_creation.md +++ b/_docs/sysadmin/configuration/ansible_course_creation.md @@ -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 @@ -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. \ No newline at end of file +See also: +[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation) \ No newline at end of file diff --git a/_docs/sysadmin/configuration/ansible_term_creation.md b/_docs/sysadmin/configuration/ansible_term_creation.md index 45c7c7b2..f31d96e2 100644 --- a/_docs/sysadmin/configuration/ansible_term_creation.md +++ b/_docs/sysadmin/configuration/ansible_term_creation.md @@ -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 @@ -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. \ No newline at end of file +See also: +[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation) \ No newline at end of file diff --git a/_docs/sysadmin/installation/ansible.md b/_docs/sysadmin/installation/ansible.md index a2b4ad93..bce39395 100644 --- a/_docs/sysadmin/installation/ansible.md +++ b/_docs/sysadmin/installation/ansible.md @@ -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) @@ -18,9 +18,8 @@ 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: @@ -28,15 +27,17 @@ Getting Started: 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 @@ -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 @@ -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) \ No newline at end of file diff --git a/navtreedata.js b/navtreedata.js index 39e7bfa2..216aa2f5 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -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 ],