Skip to content

Commit

Permalink
Update from review
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgrady committed Mar 21, 2024
1 parent 362d900 commit 82337d8
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 62 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ A rapid word collection tool. See the [User Guide](https://sillsdev.github.io/Th
6. [Inspect Database](#inspect-database)
7. [Add or Update Dictionary Files](#add-or-update-dictionary-files)
8. [Cleanup Local Repository](#cleanup-local-repository)
9. [Generate Installer Script for The Combine](#generate-installer-script-for-the-combine-linux-only)
3. [Setup Local Kubernetes Cluster](#setup-local-kubernetes-cluster)
1. [Install Rancher Desktop](#install-rancher-desktop)
2. [Install Docker Desktop](#install-docker-desktop)
Expand Down Expand Up @@ -127,16 +128,17 @@ A rapid word collection tool. See the [User Guide](https://sillsdev.github.io/Th
`dotnet tool update --global dotnet-reportgenerator-globaltool --version 5.0.4`
11. [dotnet-project-licenses](https://github.com/tomchavakis/nuget-license)
`dotnet tool update --global dotnet-project-licenses`
12. Tools for generating the self installer [Linux Only]:
12. Tools for generating the self installer [Linux only]:

- [makeself](https://makeself.io/) - a tool to make self-extracting archives in Unix
- [pandoc](https://pandoc.org/installing.html#linux) - a tool to convert Markdown documents to PDF. In addition to
`pandoc`, the `weasyprint` PDF engine is required. These may be installed on Debian-based distributions by
running:
- [pandoc](https://pandoc.org/installing.html#linux) - a tool to convert Markdown documents to PDF.
- `weasyprint` a PDF engine for `pandoc`.

```console
sudo apt install -y pandoc weasyprint
```
These can be installed on Debian-based distributions by running:

```console
sudo apt install -y makeself pandoc weasyprint
```

### Prepare the Environment

Expand Down Expand Up @@ -515,7 +517,7 @@ of development setup errors. Run from within a Python virtual environment.
python scripts/cleanup_local_repo.py
```

### Generate Installer Script for The Combine (_Linux Only_)
### Generate Installer Script for The Combine (_Linux only_)

To generate the installer script, run the following commands starting in the project top level directory:

Expand Down
2 changes: 1 addition & 1 deletion deploy/ansible/host_vars/localhost/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ ap_ssid: "thecombine_ap"
ap_passphrase: "Combine2020"
ap_gateway: "10.10.10.1"
ap_hostname: "local"

test_wifi: false
################################################
# hardware monitoring settings
################################################
Expand Down
7 changes: 3 additions & 4 deletions deploy/ansible/playbook_desktop_setup.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
##############################################################
# Playbook: playbook_kube_install.yml
# Playbook: playbook_desktop_install.yml
#
# playbook_kube_install.yml installs the packages and
# playbook_desktop_install.yml installs the packages and
# configuration files that are required to run TheCombine
# as Docker containers managed by a Kubernetes cluster.
# as containers managed by a Kubernetes cluster on localhost.
#
##############################################################

Expand All @@ -15,7 +15,6 @@

vars_files:
- "vars/config_common.yml"
- "vars/packages.yml"

tasks:
- name: Update packages
Expand Down
8 changes: 4 additions & 4 deletions deploy/ansible/playbook_nuc_setup.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
##############################################################
# Playbook: playbook_kube_install.yml
# Playbook: playbook_nuc_install.yml
#
# playbook_kube_install.yml installs the packages and
# playbook_nuc_install.yml installs the packages and
# configuration files that are required to run TheCombine
# as Docker containers managed by a Kubernetes cluster.
# as Docker containers managed by a Kubernetes cluster on
# a target PC, such as an Intel NUC.
#
##############################################################

Expand All @@ -15,7 +16,6 @@

vars_files:
- "vars/config_common.yml"
- "vars/packages.yml"

tasks:
- name: Update packages
Expand Down
11 changes: 4 additions & 7 deletions deploy/ansible/roles/container_engine/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
##############################################################
# Role: docker_install
# Role: container_engine
#
# Install the Docker Engine, Docker Compose and all their
# pre-requisite packages.
# Install the container engine and pre-requisite packages.
#
# The Docker Engine is installed by adding the repo from
# The container engine is installed by adding the repo from
# docker.com to our apt sources and installing the relevant
# package.
# packages.
#
# Docker Compose is installed by downloading the ZIP package
# from GitHub and extracting it to /usr/local/bin
##############################################################
- name: Update apt cache.
apt:
Expand Down
5 changes: 0 additions & 5 deletions deploy/ansible/roles/package_install/defaults/main.yml

This file was deleted.

15 changes: 0 additions & 15 deletions deploy/ansible/roles/package_install/tasks/main.yml

This file was deleted.

4 changes: 3 additions & 1 deletion deploy/ansible/roles/wifi_ap/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
ap_ssid: "{{ ansible_hostname }}_ap"
ap_passphrase: "Set a new passphrase in your config file."
ap_gateway: "10.10.10.1"
ap_domain: example.com
ap_domain: thecombine.app
ap_hostname: "{{ ansible_hostname }}"

wifi_if_name: "{{ ansible_interfaces | join(' ') | regex_replace('^.*\\b(wl[a-z0-9]+).*$', '\\1') }}"
ap_hosts_config: /etc/create_ap/create_ap.hosts
create_ap_config: /etc/create_ap/create_ap.conf

test_wifi: true
9 changes: 4 additions & 5 deletions deploy/ansible/roles/wifi_ap/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
tags:
- install
- meta: flush_handlers
# - name: Test WiFi Access point
# include_tasks:
# file: test.yml
# tags:
# - test
- name: Test WiFi Access point
include_tasks:
file: test.yml
when: test_wifi
8 changes: 0 additions & 8 deletions deploy/ansible/vars/packages.yml

This file was deleted.

1 change: 1 addition & 0 deletions deploy/scripts/setup_files/combine_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ targets:
profile: desktop
env_vars_required: false
override:
# override values for 'thecombine' chart
thecombine:
global:
serverName: local.thecombine.app
Expand Down
7 changes: 3 additions & 4 deletions installer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This README describes how to install _The Combine_ Rapid Word Collection tool on
3. [Running _The Combine_](#running-the-combine)
4. [Advanced Installation Options](#advanced-installation-options)

### System Requirements
## System Requirements

_The Combine_ can be installed on a PC that meets the following requirements:

Expand All @@ -19,10 +19,9 @@ _The Combine_ can be installed on a PC that meets the following requirements:
- a wired-ethernet connection to the Internet
- User account that can run as `root` with `sudo`.

The installation script has been tested on _Ubuntu 22.04_ and _Wasta
Linux 22.04_.
The installation script has been tested on _Ubuntu 22.04_ and _Wasta Linux 22.04_.

### Install _The Combine_
## Install _The Combine_

1. Plug in the wired ethernet connection to the Internet.
2. Update all of the existing software packages through your OS's _Software Updater_ application or by running:
Expand Down

0 comments on commit 82337d8

Please sign in to comment.