Improves Docker Installation Files #988

aryanpingle · 2024-10-15T17:11:55Z

Improve Docker Installation Files

Aims to address issue #748. Specifically:

Renaming CLIENT_xyz to OAUTH_CLIENT_xyz
Renaming lib.docker to lib.env
Refactor docker-compose files and remove version tags from them
Adding level: DEBUG to traefik and traefik-forward-auth containers
Hardcoding CLIENT_CONFIG into installation files

Type of Change

✅ Documentation update
✅ Refactoring

Impact

Will improve the docker installation guide and make code more readable.

Checklist

✅ My code adheres to the coding and style guidelines of the project.
✅ I have added tests for all the new code and any changes made to
existing code.
✅ I have made corresponding changes to the documentation.

aryanpingle · 2024-10-15T17:22:37Z

I had to rename the variable names in AUTHMS.drawio as well, which made one line overflow horizontally. In this commit I edited it using drawio.com, and here's how it looks now:

Before	After

It seems to have also changed some drawio metadata variables, I'm not sure if those matter:

prasadtalasila · 2024-10-16T12:38:15Z

I had to rename the variable names in AUTHMS.drawio as well, which made one line overflow horizontally. In this commit I edited it using drawio.com, and here's how it looks now:

Before After

It seems to have also changed some drawio metadata variables, I'm not sure if those matter:

The revised figure has CLIENT_ID at the top. It should be OAUTH_CLIENT_ID.

The diff on drawio file can be ignored

prasadtalasila · 2024-10-16T12:38:45Z

@aryanpingle Please search for old variables in docs/ and replace them with the new names.

aryanpingle · 2024-10-17T09:43:08Z

@prasadtalasila Yep I've updated all instances of the CLIENT_ID and CLIENT_SECRET environment variables in the docs as well.

I haven't modified any of the client side code like this:

export interface OidcConfig {
  // ...
  client_id: string;
  // ...
}

Should I change these? On one hand they aren't gonna be confused with traefik variables, but on the other hand using the OAUTH_ prefix would make things consistent.

docker/compose.dev.yml

prasadtalasila · 2024-10-17T11:39:07Z

@prasadtalasila Yep I've updated all instances of the CLIENT_ID and CLIENT_SECRET environment variables in the docs as well.

I haven't modified any of the client side code like this:
export interface OidcConfig {
  // ...
  client_id: string;
  // ...
}
Should I change these? On one hand they aren't gonna be confused with traefik variables, but on the other hand using the OAUTH_ prefix would make things consistent.

This code is in client. Please do not change it. The scope of change proposed here must be restricted to: docker, docs and deploy.

prasadtalasila · 2024-10-18T06:01:49Z

deploy/docker/compose.server.secure.yml

@@ -42,7 +42,7 @@ services:
    image: intocps/libms:latest
    restart: unless-stopped
    volumes:
-      - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env
+      - ${DTAAS_DIR}/deploy/config/lib.env:/dtaas/libms/.env


This line can be removed. Please check the same with a sample installation.

prasadtalasila · 2024-10-18T06:04:01Z

deploy/docker/compose.server.yml

@@ -20,7 +20,7 @@ services:
    image: intocps/libms:latest
    restart: unless-stopped
    volumes:
-      - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env
+      - ${DTAAS_DIR}/deploy/config/lib.env:/dtaas/libms/.env


Same here. It could be removed.

prasadtalasila · 2024-10-18T06:05:17Z

docker/libms.npm.dockerfile

please build it once to make sure that the change works as expected. BTW, does docker/libms.dockerfile change?

Nope I couldn't find any references to lib.docker in libms.dockerfile, so it hasn't changed. Only lib.npm.dockerfile.

you are right.

prasadtalasila · 2024-10-18T06:23:29Z

cli/tests/compose.users.test.yml

Please run the poetry commands, especially tests suggested in DEVELOPER to make sure that the change is a non-breaking type.

prasadtalasila · 2024-10-18T06:34:16Z

TODO: issue #954 needs to be addressed in this PR

prasadtalasila · 2024-10-21T06:52:35Z

@aryanpingle The following changes are required in the PR as well.

Line-12 of lib.npm.dockerfile (please check docker buildx after the change)
Remove the lib.env volume (file) mapping from server installatiin files and check
Documentation
* docs/admin/host.md
* deploy/docker/SERVER.md
Remove version from docker/compose.dev.yml.

This reverts commit 506ff64.

aryanpingle · 2024-10-22T08:59:23Z

Running docker buildx build -t intocps/libms:latest -f ./docker/libms.npm.dockerfile . builds successfully
Checked if lib.env mapping can be removed
Documentation has been modified
Removed version from docker/compose.dev.yml

* Inlines the path to the client configuration file for compose and env files

codeclimate · 2024-10-23T06:42:01Z

deploy/docker/LOCALHOST.md

+!!! tip
+    Important points to note:
+
+    1. The path examples given here are for Linux OS.


Code block style

codeclimate · 2024-10-23T06:42:01Z

deploy/docker/LOCALHOST.SECURE.md

+!!! tip
+    Important points to note:
+
+    1. The path examples given here are for Linux OS.


Code block style

codeclimate · 2024-10-23T06:42:01Z

docs/admin/localhost.md

-    These paths can be Windows OS compatible paths as well.
+    Important points to note:
+
+    1. The path examples given here are for Linux OS.


Code block style

aryanpingle · 2024-10-24T07:01:06Z

PR Summary

Renames lib.docker to lib.env
Removes lib.env mapping from the libms container
Adds OAUTH_ prefix to authorization variables
Enables debugging for traefik & forward-auth
Inlines the CLIENT_CONFIG variable directly into compose files
Refactors docker-compose files (by removing the version tag)
Updated the relevant markdown files

@prasadtalasila I'm not too sure, but I think the codeclimate issues are due it not understanding the mkdocs call-outs like !!! tip.

Tested this branch on a clean install: localhost and server (http and https) all run correctly. I used the integrated gitlab instance while testing in case it matters, which it likely shouldn't.

prasadtalasila

@aryanpingle Thanks for the updates. Please see the comments.

deploy/docker/DOCKER-ENV.md

deploy/docker/LOCALHOST.SECURE.md

deploy/docker/LOCALHOST.md

deploy/docker/SERVER.md

docker/compose.dev.yml

prasadtalasila · 2024-10-24T08:53:28Z

docker/compose.dev.yml

In addition, the libms is using servers/lib/config/.env.default. The developers do not have a choice of specifying config file. A new variable named LIB_CONFIG needs to be added to docker/.env file and needs to be volume mapped to libms service.

Can you explain this a bit further? If I understand correctly:

Add a variable to .env.default: LIB_CONFIG='/dev/null' (can't map an empty string to a docker container)

Add this line to compose.lib.dev.yml:

volumes: ... - ${LIB_CONFIG}:/dtaas/libms/.env

codeclimate · 2024-10-24T09:47:00Z

deploy/docker/LOCALHOST.SECURE.md

+1. The path examples given here are for Linux OS.
+   These paths can be Windows OS compatible paths as well.
+1. The client configuration file is located at `deploy/config/client/env.local.js`.
+   Edit the URLs in this file by replacing `http` with `https`. Beyond this, it is not necessary to modify this file.


Line length

codeclimate · 2024-10-24T09:47:01Z

docs/admin/host.md

+   These paths can be Windows OS compatible paths as well.
+1. The client configuration file is located at `deploy/config/client/env.js`.
+1. The Server DNS can also be an IP address.
+   However, for proper working it is neccessary to use the same convention (IP/DNS) in the client configuration file as well.


Line length

@prasadtalasila minor issue, but it's not possible to put a line break here without it creating a new line in the bullet point list. I could instead use HTML markup like so:

<ol> <li> The path examples given here are for Linux OS.<br> These paths can be Windows OS compatible paths as well. </li> <li> The client configuration file is located at <code>deploy/config/client/env.local.js</code>.<br> Edit the URLs in this file by replacing <code>http</code> with <code>https</code>. Beyond this, it is not necessary to modify this file. </li> </ol>

Preview:

The path examples given here are for Linux OS.
These paths can be Windows OS compatible paths as well.

The client configuration file is located at deploy/config/client/env.local.js.
Edit the URLs in this file by replacing http with https. Beyond this, it is not necessary to modify this file.

It looks cleaner in the markdown, and makes it more customizable - but it's up to you whether it fits the conventions

codeclimate · 2024-10-24T09:47:01Z

docs/admin/localhost.md

+1. The path examples given here are for Linux OS.
+   These paths can be Windows OS compatible paths as well.
+1. The client configuration file is located at `deploy/config/client/env.local.js`.
+   If you are following the guide to use HTTPS on localhost, edit the URLs in this file by replacing `http` with `https`.


Line length

codeclimate · 2024-10-29T07:33:49Z

Code Climate has analyzed commit 3c1b821 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Style	1

View more on Code Climate.

- Cleans up docker compose files by renaming variables, removing unnecessary variables and tags. - Updates the installation documents --------- Co-authored-by: aryanpingle <[email protected]>

prasadtalasila · 2024-10-30T13:52:03Z

merged via PR #1019

aryanpingle added 3 commits October 15, 2024 22:17

Rename lib.docker to lib.env

9333d02

Add OAUTH_ prefix to auth variables

a074708

Update auth microservice diagram

08b1fd6

Update auth microservice diagram

bd2fae0

Enable debugging for traefik + forward auth for devs

39a1e79

aryanpingle commented Oct 17, 2024

View reviewed changes

docker/compose.dev.yml Show resolved Hide resolved

Removes version tag from docker-compose files

19a4fa5

prasadtalasila reviewed Oct 18, 2024

View reviewed changes

aryanpingle added 2 commits October 21, 2024 13:25

Remove version tag from test expectation

506ff64

Revert "Remove version tag from test expectation"

c2d1f4e

This reverts commit 506ff64.

prasadtalasila added this to the Release v0.6.0 milestone Oct 22, 2024

aryanpingle added 2 commits October 23, 2024 11:06

Removes CLIENT_CONFIG variable

827a059

* Inlines the path to the client configuration file for compose and env files

Remove CLIENT_CONFIG variable from docs

31380d1

codeclimate bot reviewed Oct 23, 2024

View reviewed changes

Remove lib.env mapping from libms container

9755fc7

prasadtalasila reviewed Oct 24, 2024

View reviewed changes

Remove some mkdocs callouts for 'tip'

7e50b9d

codeclimate bot reviewed Oct 24, 2024

View reviewed changes

aryanpingle added 2 commits October 24, 2024 15:17

Preserve mkdocs tip callout for docs/admin

1030568

Remove lib.env mapping from SERVER.md

ce71406

aryanpingle added 5 commits October 24, 2024 15:20

Add OAUTH prefix for docker/.env

a3fc61a

Adds a LIB_CONFIG variable for the libms env file

8e3f96c

Format markdowns

5c17bf0

Enable debugging for traefik + forward auth

5480703

Fix incorrect docker commands in LOCALHOST.SECURE.md

3c1b821

prasadtalasila mentioned this pull request Oct 30, 2024

Improves Docker Installation Files (on top of #988) #1019

Merged

prasadtalasila closed this Oct 30, 2024

This was referenced Oct 30, 2024

Hardcode CLIENT_CONFIG into installation files #954

Closed

Improve docker installation files #748

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improves Docker Installation Files #988

Improves Docker Installation Files #988

aryanpingle commented Oct 15, 2024 •

edited

Loading

aryanpingle commented Oct 15, 2024

prasadtalasila commented Oct 16, 2024

prasadtalasila commented Oct 16, 2024

aryanpingle commented Oct 17, 2024

prasadtalasila commented Oct 17, 2024

prasadtalasila Oct 18, 2024

prasadtalasila Oct 18, 2024

prasadtalasila Oct 18, 2024

aryanpingle Oct 18, 2024

prasadtalasila Oct 18, 2024

prasadtalasila Oct 18, 2024

prasadtalasila commented Oct 18, 2024

prasadtalasila commented Oct 21, 2024

aryanpingle commented Oct 22, 2024 •

edited

Loading

codeclimate bot Oct 23, 2024

codeclimate bot Oct 23, 2024

codeclimate bot Oct 23, 2024

aryanpingle commented Oct 24, 2024

prasadtalasila left a comment

prasadtalasila Oct 24, 2024

aryanpingle Oct 24, 2024

codeclimate bot Oct 24, 2024

codeclimate bot Oct 24, 2024

aryanpingle Oct 24, 2024

codeclimate bot Oct 24, 2024

codeclimate bot commented Oct 29, 2024

prasadtalasila commented Oct 30, 2024

Improves Docker Installation Files #988

Improves Docker Installation Files #988

Conversation

aryanpingle commented Oct 15, 2024 • edited Loading

Improve Docker Installation Files

Type of Change

Impact

Checklist

aryanpingle commented Oct 15, 2024

prasadtalasila commented Oct 16, 2024

prasadtalasila commented Oct 16, 2024

aryanpingle commented Oct 17, 2024

prasadtalasila commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prasadtalasila commented Oct 18, 2024

prasadtalasila commented Oct 21, 2024

aryanpingle commented Oct 22, 2024 • edited Loading

codeclimate bot Oct 23, 2024

Choose a reason for hiding this comment

codeclimate bot Oct 23, 2024

Choose a reason for hiding this comment

codeclimate bot Oct 23, 2024

Choose a reason for hiding this comment

aryanpingle commented Oct 24, 2024

PR Summary

prasadtalasila left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot Oct 24, 2024

Choose a reason for hiding this comment

codeclimate bot Oct 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot Oct 24, 2024

Choose a reason for hiding this comment

codeclimate bot commented Oct 29, 2024

prasadtalasila commented Oct 30, 2024

aryanpingle commented Oct 15, 2024 •

edited

Loading

aryanpingle commented Oct 22, 2024 •

edited

Loading