Finalizing Docker Compose files and configuration options

2023-02-23 15:52:00 -05:00
parent 8d151e0836
commit 75298887d2
5 changed files with 151 additions and 32 deletions
--- a/.env.default
+++ b/.env.default
@@ -0,0 +1,58 @@
+# One Sky IT's Aether Framework and System
+
+OSIT_ENV=development
+# OSIT_ENV=production
+# OSIT_ENV=testing
+
+# Aether general shared config options
+# For general shared config options like API access and use, database access and use, Redis, and SMTP
+# home development, live testing, live production, onsite development, onsite testing, onsite production???
+AE_CFG_ID=0
+
+## Aether API access and use
+AE_API_PROTOCOL=https
+AE_API_SERVER=dev-api.oneskyit.com
+AE_API_PORT=443
+AE_API_PATH=
+AE_API_SECRET_KEY=the-secret-api-key
+
+## Aether DB access and use
+AE_DB_SERVER=linode.oneskyit.com
+AE_DB_PORT=3306
+AE_DB_NAME=aether_dev
+# AE_DB_USERNAME=osit_aether
+AE_DB_USERNAME=onesky_aether
+AE_DB_PASSWORD="the password with $$ escape"
+
+## Aether Redis access and use
+AE_REDIS_SERVER=redis
+AE_REDIS_PORT=6379
+
+## Aether SMTP access and use
+AE_SMTP_SERVER=linode.oneskyit.com
+AE_SMTP_PORT=465
+AE_SMTP_USERNAME=send_mail
+# AE_SMTP_PASSWORD="not currently used"
+
+
+# Aether API specific config options (FastAPI)
+# AE_API_CFG_ID=0 # NOT CURRENTLY NEED OR USED
+AE_API_ENV=development
+AE_API_DIR=/srv/aether_api
+AE_API_LOG_PATH="/logs/aether_api.log"
+AE_API_WORKERS=1
+AE_API_THREADS=1
+AE_API_RELOAD=False
+
+
+# Aether app specific config (Flask with Svelte)
+AE_APP_CFG_ID=0
+AE_APP_ENV=development
+AE_APP_UX_MODE=default
+# AE_APP_UX_MODE=onsite
+# AE_APP_UX_MODE=native
+AE_APP_DIR=/srv/aether_app
+AE_APP_LOG_PATH="/logs/aether_app.log"
+AE_APP_WORKERS=1
+AE_APP_THREADS=1
+AE_APP_RELOAD=True
--- a/README.md
+++ b/README.md
@@ -2,11 +2,61 @@ This can be used to create a Docker server cluster for the Aether App using Flas

 ## Initialize
 ### Part 1
+* Create directory and clone the Aether environment.
 ```bash
 sudo mkdir /srv/env
 sudo chown -R scott:scott /srv/env/
 git clone https://scott_idem@bitbucket.org/oneskyit/one-sky-it-container-environment.git /srv/env/test_aether
+```

+### Part 2
+* Create links to needed for the srv/ directories. See the README.md file under srv/ for details.
+* Copy Let's Encrypt certificates to the conf/certs/ directory. See the README.md file under conf/certs/ for details.
+* Copy MariaDB database files to the srv/mariadb/ directory using rsync. The original files may need to be copied from the normal Arch Linux location (/var/lib/mysql) first and then possibly reset the root password.
+```bash
+sudo rsync -vhr -progress /var/lib/mysql/ /srv/env/test_aether/srv/mariadb/
+sudo rsync -vhrz scott@linode.oneskyit.com:/srv/env/test_aether/srv/mariadb/ /srv/mariadb/
+```
+
+### Part 3
+* Create the environment settings file and place it under the root of the Docker Compose directory. Copy the .env.default file as a template.
+```bash
+cp /srv/env/test_aether/.env /srv/env/test_aether/.env.bak
+cp /srv/env/test_aether/.env.default /srv/env/test_aether/.env
+```
+**/.env**
+```sh
+# One Sky IT's Aether Framework and System
+
+OSIT_ENV=development
+
+# Aether general shared config options
+## Aether API access and use
+## Aether DB access and use
+## Aether Redis access and use
+## Aether SMTP access and use
+
+# Aether API specific config options (FastAPI)
+
+# Aether app specific config (Flask with Svelte)
+
+KEY="The Value"
+```
+
+
+## Manage Docker Compose Environment
+```bash
+docker restart ae_api_dev
+docker restart ae_app_dev
+docker restart ae_mariadb_dev
+```
+
+---
+
+## More Notes
+
+
+```bash
 ln -s /srv/http/dev_app.oneskyit.com /srv/env/test_aether/srv/aether_app_ln
 ln -s /srv/http/dev_fastapi.oneskyit.com /srv/env/test_aether/srv/aether_api_ln
 ln -s /mnt/data/speaker_ready/hosted_tmp /srv/env/test_aether/srv/hosted_tmp_ln
--- a/conf/aether_api_config.py
+++ b/conf/aether_api_config.py
@@ -10,86 +10,95 @@ from typing import Any, Dict, List, Optional, Union
 class Settings(BaseSettings):
    AETHER_CFG = {}
    AETHER_CFG['id'] = os.getenv('AE_CFG_ID', None)
-    AETHER_CFG['api_id'] = os.getenv('AE_API_CFG_ID', None)
+    # AETHER_CFG['api_id'] = os.getenv('AE_API_CFG_ID', None) # NOT CURRENTLY NEED OR USED

-    APP_NAME: str = "Aether API (FastAPI)"
-    SUPER_EMAIL: EmailStr = 'Aether.Super@oneskyit.com'
+
+    # APP_NAME: str = "Aether API (FastAPI)"
+    # SUPER_EMAIL: EmailStr = 'Aether.Super@oneskyit.com'


    # Database Connection
    DB = {}
-    DB['server'] = os.getenv('AE_DB_SERVER', None) # 'linode.oneskyit.com' # linode.oneskyit.com, vpn-linode linode.oneskyit.local
-    DB['port'] = os.getenv('AE_DB_PORT', None) # '3306' # default = 3306
+    DB['server'] = os.getenv('AE_DB_SERVER', 'mariadb') # 'linode.oneskyit.com' # linode.oneskyit.com, vpn-linode linode.oneskyit.local
+    DB['port'] = os.getenv('AE_DB_PORT', '3306') # default = 3306
    DB['name'] = os.getenv('AE_DB_NAME', None) # 'aether_dev' #onesky_ams_dev
    DB['username'] = os.getenv('AE_DB_USERNAME', None) # 'osit_aether' # 'onesky_aether'
    DB['password'] = os.getenv('AE_DB_PASSWORD', None) #
-    print(DB)
    SQLALCHEMY_DB_URI = 'mysql://'+DB['username']+':'+DB['password']+'@'+DB['server']+'/'+DB['name']


    # Aether API log files paths
    LOG_PATH = {}
-    LOG_PATH['app'] = '/logs/aether_api.log' # 'admin/log/app.log', '../../logs/aether_api.log'
-    LOG_PATH['app_warning'] = '/logs/aether_api_warning.log' # 'admin/log/app_warning.log' '../../logs/aether_api_warning.log'
+    LOG_PATH['app'] = os.getenv('AE_API_LOG_PATH', 'admin/log/app.log') # 'admin/log/app.log', '../../logs/aether_api.log'
+    # LOG_PATH['app_warning'] = '/logs/aether_api_warning.log' # 'admin/log/app_warning.log' '../../logs/aether_api_warning.log'


    # Redis
    REDIS = {}
-    REDIS['server'] = os.getenv('AE_REDIS_SERVER', None) # 'redis' # 'localhost' 'redis'
-    REDIS['port'] = os.getenv('AE_REDIS_PORT', None) # '6379'
+    REDIS['server'] = os.getenv('AE_REDIS_SERVER', 'redis') # 'localhost' 'redis'
+    REDIS['port'] = os.getenv('AE_REDIS_PORT', '6379') # '6379'


    # Send SMTP Email
    SMTP = {}
+    # server
+    # port
+    # username
+    # password


    # Server Hosted File Paths
    FILES_PATH = {}
+    # hosted_files_root
+    # hosted_tmp_root


    # CORS Origins
    ORIGINS_REGEX = '(https://.*\.oneskyit\.com)|(http://.*\.oneskyit\.com)|(http://.*\.oneskyit\.com:8181)|(https://.*\.oneskyit\.com:8443)|(http://.*\.oneskyit\.local)|(http://.*\.oneskyit\.local:5000)|(http://.*.localhost)|(http://.*.localhost:5000)|(http://.*.localhost:8181)'
+    # A reasonable, but fairly open example regular expression for the CORS origins:
+    # '(https://.*\.oneskyit\.com)|(http://.*\.oneskyit\.com)|(http://.*\.oneskyit\.com:8181)|(https://.*\.oneskyit\.com:8443)|(http://.*\.oneskyit\.local)|(http://.*\.oneskyit\.local:5000)|(http://.*.localhost)|(http://.*.localhost:5000)|(http://.*.localhost:8181)'

    ORIGINS = [
        'https://oneskyit.com',
-        'http://app-local.oneskyit.com',
+        # 'http://app-local.oneskyit.com',
        'http://192.168.32.20:3000',
        'http://192.168.32.20:8080',

        'http://localhost',
        'http://localhost:3000',
-        'http://localhost:5000',
-        'http://localhost:8080',
+        # 'http://localhost:5000',
        'http://localhost:7800',
+        # 'http://localhost:8080',
+        # 'http://localhost:8888',

-        'http://fastapi.localhost',
+        # 'http://fastapi.localhost',

        'http://svelte.oneskyit.local:5555',

-        'http://connect.localhost:5000', # Using localhost
+        # 'http://connect.localhost:5000', # Using localhost

-        'http://dev-svelte.oneskyit.local:5555',
+        # 'http://dev-svelte.oneskyit.local:5555',

-        'http://lci.internal:5000', # Using internal; just in case guess before LCI
-        'http://lci.oneskyit.internal:5000', # Using internal; just in case guess before LCI
-        'http://lci.oneskyit.internal', # Using internal; just in case guess before LCI
+        # 'http://lci.internal:5000', # Using internal; just in case guess before LCI
+        # 'http://lci.oneskyit.internal:5000', # Using internal; just in case guess before LCI
+        # 'http://lci.oneskyit.internal', # Using internal; just in case guess before LCI
        ]


    # HTTP Status Dict List
    HTTP_STATUS_LI = {}
-    HTTP_STATUS_LI[200] = { 'name': 'OK', 'message': 'The request has succeeded.' }
-    HTTP_STATUS_LI[400] = { 'name': 'Bad Request', 'message': 'The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.' }
-    HTTP_STATUS_LI[401] = { 'name': 'Unauthorized', 'message': 'The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser does not understand how to supply the credentials required.' }
-    HTTP_STATUS_LI[402] = { 'name': '?Request Failed?', 'message': '??The parameters were valid but the request failed.??' }
-    HTTP_STATUS_LI[403] = { 'name': 'Forbidden', 'message': 'The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.' }
-    HTTP_STATUS_LI[404] = { 'name': 'Not Found', 'message': 'The requested resource does not exist.' }
-    HTTP_STATUS_LI[409] = { 'name': 'Conflict', 'message': 'The request conflicts with another request (perhaps due to using the same idempotent key).' }
-    HTTP_STATUS_LI[429] = { 'name': 'Too Many Requests', 'message': 'Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.' }
-    HTTP_STATUS_LI[500] = { 'name': 'Internal Server Error', 'message': 'The server encountered an unexpected condition which prevented it from fulfilling the request.' }
-    HTTP_STATUS_LI[501] = { 'name': 'Not Implemented', 'message': 'The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.' }
-    HTTP_STATUS_LI[502] = { 'name': 'Bad Gateway', 'message': 'The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.' }
-    HTTP_STATUS_LI[503] = { 'name': 'Service Unavailable', 'message': 'The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.' }
-    HTTP_STATUS_LI[504] = { 'name': 'Gateway Timeout', 'message': 'The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.' }
+    # HTTP_STATUS_LI[200] = { 'name': 'OK', 'message': 'The request has succeeded.' }
+    # HTTP_STATUS_LI[400] = { 'name': 'Bad Request', 'message': 'The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.' }
+    # HTTP_STATUS_LI[401] = { 'name': 'Unauthorized', 'message': 'The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser does not understand how to supply the credentials required.' }
+    # HTTP_STATUS_LI[402] = { 'name': '?Request Failed?', 'message': '??The parameters were valid but the request failed.??' }
+    # HTTP_STATUS_LI[403] = { 'name': 'Forbidden', 'message': 'The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.' }
+    # HTTP_STATUS_LI[404] = { 'name': 'Not Found', 'message': 'The requested resource does not exist.' }
+    # HTTP_STATUS_LI[409] = { 'name': 'Conflict', 'message': 'The request conflicts with another request (perhaps due to using the same idempotent key).' }
+    # HTTP_STATUS_LI[429] = { 'name': 'Too Many Requests', 'message': 'Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.' }
+    # HTTP_STATUS_LI[500] = { 'name': 'Internal Server Error', 'message': 'The server encountered an unexpected condition which prevented it from fulfilling the request.' }
+    # HTTP_STATUS_LI[501] = { 'name': 'Not Implemented', 'message': 'The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.' }
+    # HTTP_STATUS_LI[502] = { 'name': 'Bad Gateway', 'message': 'The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.' }
+    # HTTP_STATUS_LI[503] = { 'name': 'Service Unavailable', 'message': 'The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.' }
+    # HTTP_STATUS_LI[504] = { 'name': 'Gateway Timeout', 'message': 'The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.' }

 settings = Settings()
--- a/testing.env
+++ b/testing.env
@@ -0,0 +1 @@
+ 
--- a/testing.env.default
+++ b/testing.env.default
@@ -0,0 +1 @@
+