refactor: Update terminology from 'services' to 'adapters' and standardize configuration comments

Author: Bit-Maximum

README.md

@@ -53,11 +53,11 @@ app
 │   ├── dao  # Data Access Objects. Contains different classes to interact with database.
 │   └── models  # Package contains different models for ORMs.
 ├── __main__.py  # Startup script. Starts uvicorn.
-├── services  # Package for different external services such as rabbit or redis etc.
+├── adapters  # Package for different external adapters such as rabbit or redis etc.
 ├── settings.py  # Main configuration settings for project.
 ├── static  # Static content.
 ├── tests  # Tests for project.
-└── web  # Package contains web server. Handlers, startup config.
+└── controller  # Package contains controller server. Handlers, startup config.
     ├── api  # Package with all handlers.
     │   └── router.py  # Main router.
     ├── application.py  # FastAPI application configuration.

deploy/docker/docker-compose.prometheus.yml

@@ -3,14 +3,14 @@ services:
     image: ${PROMETHEUS_IMAGE}
     container_name: prometheus
     command:
-      - --web.console.templates=/etc/prometheus/consoles
-      - --web.console.libraries=/etc/prometheus/console_libraries
+      - --controller.console.templates=/etc/prometheus/consoles
+      - --controller.console.libraries=/etc/prometheus/console_libraries
       - --storage.tsdb.retention.time=1h
       - --config.file=/etc/prometheus/prometheus-config.yaml
       - --storage.tsdb.path=/prometheus
-      - --web.enable-lifecycle
-      - --web.route-prefix=/
-      - --web.enable-otlp-receiver
+      - --controller.enable-lifecycle
+      - --controller.route-prefix=/
+      - --controller.enable-otlp-receiver
       - --enable-feature=exemplar-storage
     volumes:
       - ./src/prometheus/prometheus-config.yaml:/etc/prometheus/prometheus-config.yaml

deploy/docker/docker-compose.traefik.yml

@@ -13,8 +13,8 @@ services:
       # Use the traefik-public network (declared below)
       - traefik.docker.network=traefik-public
       # Define the port inside of the Docker service to use
-      - traefik.http.services.traefik-dashboard.loadbalancer.server.port=8080
-      # Make Traefik use this domain (from an environment variable) in HTTP
+      - traefik.http.adapters.traefik-dashboard.loadbalancer.server.port=8080
+      # Make Traefik use this services (from an environment variable) in HTTP
       - traefik.http.routers.traefik-dashboard-http.entrypoints=http
       - traefik.http.routers.traefik-dashboard-http.rule=Host(`traefik.${DOMAIN?Variable not set}`)
       # traefik-https the actual router using HTTPS
@@ -23,7 +23,7 @@ services:
       - traefik.http.routers.traefik-dashboard-https.tls=true
       # Use the "le" (Let's Encrypt) resolver created below
       - traefik.http.routers.traefik-dashboard-https.tls.certresolver=le
-      # Use the special Traefik service api@internal with the web UI/Dashboard
+      # Use the special Traefik service api@internal with the controller UI/Dashboard
       - traefik.http.routers.traefik-dashboard-https.service=api@internal
       # https-redirect middleware to redirect HTTP to HTTPS
       - traefik.http.middlewares.https-redirect.redirectscheme.scheme=https
@@ -36,14 +36,14 @@ services:
       # Enable HTTP Basic auth, using the middleware created above
       - traefik.http.routers.traefik-dashboard-https.middlewares=admin-auth
     volumes:
-      # Add Docker as a mounted volume, so that Traefik can read the labels of other services
+      # Add Docker as a mounted volume, so that Traefik can read the labels of other adapters
       - /var/run/docker.sock:/var/run/docker.sock:ro
       # Mount the volume to store the certificates
       - traefik-public-certificates:/certificates
     command:
-      # Enable Docker in Traefik, so that it reads labels from Docker services
+      # Enable Docker in Traefik, so that it reads labels from Docker adapters
       - --providers.docker
-      # Do not expose all Docker services, only the ones explicitly exposed
+      # Do not expose all Docker adapters, only the ones explicitly exposed
       - --providers.docker.exposedbydefault=false
       # Create an entrypoint "http" listening on port 80
       - --entrypoints.http.address=:80
@@ -72,6 +72,6 @@ volumes:
 
 networks:
   # Use the previously created public network "traefik-public", shared with other
-  # services that need to be publicly available via this Traefik
+  # adapters that need to be publicly available via this Traefik
   traefik-public:
     external: true

deploy/grafana/grafana.ini

@@ -42,10 +42,10 @@ protocol = http
 # The http port  to use
 http_port = 3000
 
-# The public facing domain name used to access grafana from a browser
+# The public facing services name used to access grafana from a browser
 domain = localhost
 
-# Redirect to correct domain if host header does not match domain
+# Redirect to correct services if host header does not match services
 # Prevents DNS rebinding attacks
 ;enforce_domain = false
 
@@ -56,7 +56,7 @@ root_url = %(protocol)s://%(domain)s/grafana/
 # Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
 serve_from_sub_path = true
 
-# Log web requests
+# Log controller requests
 ;router_logging = false
 
 # the path relative working path
@@ -217,10 +217,10 @@ serve_from_sub_path = true
 # only a GET request to https://grafana.com to get the latest versions.
 ;check_for_plugin_updates = true
 
-# Google Analytics universal tracking code, only enabled if you specify an id here
+# Google Analytics universal tracking code, only enabled if you specify an dummy_id here
 ;google_analytics_ua_id =
 
-# Google Tag Manager ID, only enabled if you specify an id here
+# Google Tag Manager ID, only enabled if you specify an dummy_id here
 ;google_tag_manager_id =
 
 # Rudderstack write key, enabled only if rudderstack_data_plane_url is also set
@@ -353,7 +353,7 @@ serve_from_sub_path = true
 # Allow non admin users to create organizations
 ;allow_org_create = true
 
-# Set to true to automatically assign new users to the default organization (id 1)
+# Set to true to automatically assign new users to the default organization (dummy_id 1)
 ;auto_assign_org = true
 
 # Set this value to automatically add new users to the provided organization (if auto_assign_org above is set to true)
@@ -504,8 +504,8 @@ org_role = Admin
 ;client_id = some_client_id
 ;client_secret = some_client_secret
 ;scopes = openid email profile
-;auth_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize
-;token_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token
+;auth_url = https://login.microsoftonline.com/<tenant-dummy_id>/oauth2/v2.0/authorize
+;token_url = https://login.microsoftonline.com/<tenant-dummy_id>/oauth2/v2.0/token
 ;allowed_domains =
 ;allowed_groups =
 ;role_attribute_strict = false
@@ -518,9 +518,9 @@ org_role = Admin
 ;client_id = some_id
 ;client_secret = some_secret
 ;scopes = openid profile email groups
-;auth_url = https://<tenant-id>.okta.com/oauth2/v1/authorize
-;token_url = https://<tenant-id>.okta.com/oauth2/v1/token
-;api_url = https://<tenant-id>.okta.com/oauth2/v1/userinfo
+;auth_url = https://<tenant-dummy_id>.okta.com/oauth2/v1/authorize
+;token_url = https://<tenant-dummy_id>.okta.com/oauth2/v1/token
+;api_url = https://<tenant-dummy_id>.okta.com/oauth2/v1/userinfo
 ;allowed_domains =
 ;allowed_groups =
 ;role_attribute_path =
@@ -617,7 +617,7 @@ org_role = Admin
 ;cloud = AzureCloud
 
 # Specifies whether Grafana hosted in Azure service with Managed Identity configured (e.g. Azure Virtual Machines instance)
-# If enabled, the managed identity can be used for authentication of Grafana in Azure services
+# If enabled, the managed identity can be used for authentication of Grafana in Azure adapters
 # Disabled by default, needs to be explicitly enabled
 ;managed_identity_enabled = false
 

docker-compose.override.yml

@@ -1,6 +1,6 @@
 services:
 
-  # Local services are available on their ports, but also available on:
+  # Local adapters are available on their ports, but also available on:
   # http://api.localhost.myapp.com: backend
   # etc. To enable it, update .env, set:
   # DOMAIN=localhost.myapp.com
@@ -13,11 +13,11 @@ services:
       - "8090:8080"
     # Duplicate the command from docker-compose.yml to add --api.insecure=true
     command:
-      # Enable Docker in Traefik, so that it reads labels from Docker services
+      # Enable Docker in Traefik, so that it reads labels from Docker adapters
       - --providers.docker
-      # Add a constraint to only use services with the label for this stack
+      # Add a constraint to only use adapters with the label for this stack
       - --providers.docker.constraints=Label(`traefik.constraint-label`, `traefik-public`)
-      # Do not expose all Docker services, only the ones explicitly exposed
+      # Do not expose all Docker adapters, only the ones explicitly exposed
       - --providers.docker.exposedbydefault=false
       # Create an entrypoint "http" listening on port 80
       - --entrypoints.http.address=:80

docker-compose.yml

@@ -15,7 +15,7 @@ services:
       - traefik.docker.network=traefik-public
       - traefik.constraint-label=traefik-public
 
-      - traefik.http.services.${TRAEFIK_STACK_NAME?Variable not set}-api.loadbalancer.server.port=8000
+      - traefik.http.adapters.${TRAEFIK_STACK_NAME?Variable not set}-api.loadbalancer.server.port=8000
 
       - traefik.http.routers.${TRAEFIK_STACK_NAME?Variable not set}-api-http.rule=Host(`api.${TRAEFIK_DOMAIN?Variable not set}`)
       - traefik.http.routers.${TRAEFIK_STACK_NAME?Variable not set}-api-http.entrypoints=http
@@ -92,7 +92,7 @@ services:
       - traefik.docker.network=traefik-public
       - traefik.constraint-label=traefik-public
 
-      - traefik.http.services.${TRAEFIK_STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080
+      - traefik.http.adapters.${TRAEFIK_STACK_NAME?Variable not set}-adminer.loadbalancer.server.port=8080
 
       - traefik.http.routers.${TRAEFIK_STACK_NAME?Variable not set}-adminer-http.rule=Host(`adminer.${TRAEFIK_DOMAIN?Variable not set}`)
       - traefik.http.routers.${TRAEFIK_STACK_NAME?Variable not set}-adminer-http.entrypoints=http

pyproject.toml

@@ -84,8 +84,11 @@ lint.ignore = [
     "ERA001",
     "PLR0913",
     "N803",
+    "N805",
     "N815",
     "UP046",
+    "FBT001",
+    "FBT002",
 ]
 exclude = [
     "app/db/migrations",