docs: Updated the Docker setup for portal by husainattar · Pull Request #610 · anitab-org/portal

husainattar · 2020-07-22T21:09:05Z

Description

Updated the docker-compose.yml,settings.py, Dockerfile and Readme.md
for easy project installation process through docker.

Fixes # 581

Type of Change:

Delete irrelevant options.

Code
Documentation

Code/Quality Assurance Only

Bugfix (non-breaking change which fixes an issue)

How Has This Been Tested?

Checklist:

Delete irrelevant options.

I have performed a self-review of my own code or materials
I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
I have made corresponding changes to the documentation

Code/Quality Assurance Only

My changes generate no new warnings

sakshi1499 · 2020-07-24T06:08:58Z

@husainattar There are failing tests, please push the changes to these.

husainattar · 2020-07-24T13:29:52Z

Hi @sakshi1499 actually I have not much idea with TRAVIS-CI and I have somehow resolved the failure regarding pull request build but I don't know how to resolve the failure regarding CHECK COMMIT MESSAGES.

sakshi1499 · 2020-07-24T13:38:44Z

@husainattar Actually you have 15 commits and one of them doesn't follow the Commit Guidelines so squash them and the new commit should follow the commit guideline.

husainattar · 2020-07-24T13:43:24Z

@sakshi1499 ohk so I should squash all the 15 commits and create a single one commit as per guidelines?

theyashshahs

follow the commit style guidelines

SanketDG · 2020-07-24T21:32:10Z

@husainattar There is an issue with the recent commit message checker, it does not allow capital letters in the subject

#624 should fix this.

husainattar · 2020-07-24T21:40:38Z

Ohh Thank you @SanketDG

SanketDG · 2020-07-27T19:54:05Z

@husainattar Feel free to squash the commits together! That should let go of the errors.

husainattar · 2020-07-27T21:07:44Z

Hi @SanketDG sir I actually tried everything and also squash the commit but still it provides me check-commits error. I would be grateful if anyone can provide help in this.Thank you

SanketDG · 2020-07-28T16:08:36Z

@husainattar Should be fixed now! I will review this PR some time later.

husainattar · 2020-07-28T16:16:48Z

Thank you @SanketDG sir thank you for the help.

SanketDG

This looks good, except for some minor comments.

I will also try fixing the docker documentaiton, so that it's not just a preview, but usable as a "development environment", so that a lot of the problems regarding Installation of Portal can be averted.

SanketDG · 2020-08-10T13:09:10Z

 MAINTAINER Ana Balica <ana.balica@gmail.com>
+
+# Updated by
+LABEL HUSSAIN="husainattar110@gmail.com"


I am not sure if this required, lots of people may commit on the Dockerfile in the future, we do not want to create unnecessary noise here.

I actually used because in future some needs help in changing or understand the docker file.
I tried to contact ana I guess during my docker issues but didn't get a response so I thought to include my mail for any help or maintenance something. Btw I can change it right now.

SanketDG · 2020-08-10T13:09:36Z

+# getting the base Image
+FROM python:3.6
+
 MAINTAINER Ana Balica <ana.balica@gmail.com>


It would be better we have an official Email ID here

Yes so I can remove my email.

SanketDG · 2020-08-10T13:10:12Z

@@ -1,11 +1,33 @@
-FROM python:2.7 
+# getting the base Image
+FROM python:3.6


Did you check what's the size of the resultant image? We may need to tinker with the base image to get the best results.

Yes the image size was 1.2GB with python 3.6 having 916MB. I just change the image version to keep update to date with the current documentation.

Can you try with 3.6-slim-buster, that is the image I use, and as far as I know that's the image with the smallest footprint

ok sure previously actually I used 3.6-slim and 3.6-alpine but it gave me error.

Thanks for that it reduced the size of the image to 600MB. I actually didn't use it first because the above-specified versions gave me an error that's why I keep as it is.

SanketDG · 2020-08-10T13:10:52Z

+RUN apt-get update 
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository ppa:ubuntugis/ppa 
+RUN apt-get install -y gdal-bin python-gdal python3-gdal


Do we need python-gdal?

Yes because while building it gives me an error regarding gdal lib not found during executing the cities_light command. So I tried to include and it resolved error.

Yes because while building it gives me an error regarding gdal lib not found during executing the cities_light command. So I tried to include and it resolved error.

are you sure about "python-gdal" as image using here is python3.6 , then why we need "python-gdal" library of python 2 .
As, gdal lib not found during executing the cities_light command can be fixed by only installing "python3-gdal".

Also , installing "python-gdal" here will also install python2 and other dependency in the image .

So, My suggestion is to only use "python3-gdal" here and verify for issue and also sure image size will further reduce.

SanketDG · 2020-08-10T13:13:27Z

  command: python systers_portal/manage.py runserver 0.0.0.0:8000
  volumes:
-    - .:/usr/src/portal
+     - .:/usr/src/portal


Any reasons for changing this?

The extra space has actually no specific reason . I have just re-written the docker.yml so to maintain proper indentation I guess have added extra space.

Generally. indentation is done in multiples of 2, could you change this back?

Ok, sure I am actually not aware of indentation rule.

Fix the indentation with power of 2's as required.

husainattar · 2020-08-11T18:59:19Z

Btw @SanketDG I have included some important additional commands for database and common related issues in documentation. I have just not included on how we can make changes during development and get reflect in running container instantly.

rajpratik71 · 2020-08-20T10:59:38Z

@sakshi1499 ohk so I should squash all the 15 commits and create a single one commit as per guidelines?

yes squash it and make a single commit with all changes done in description

rajpratik71 · 2020-08-20T11:02:49Z

Also , @husainattar to update your working branch with Upstream branch , you can do "git rebase" instead of merging it . This approach doesn't create a new commit in your branch.

sakshi1499 · 2020-09-23T13:31:38Z

@husainattar Are you working on this?

theyashshahs previously approved these changes Jul 24, 2020

View reviewed changes

husainattar dismissed theyashshahs’s stale review via 23fa252 July 24, 2020 14:24

husainattar force-pushed the develop branch from 7d0218d to 23fa252 Compare July 24, 2020 14:24

theyashshahs added Status: Changes Requested Changes are required to be done by the PR author. Status: Needs Review PR needs an additional review or a maintainer's review. labels Jul 26, 2020

husainattar force-pushed the develop branch 2 times, most recently from b253b4c to 743f8b5 Compare July 27, 2020 20:57

fix: Update docker image

17fd770

SanketDG force-pushed the dockerImage branch from 9051357 to 17fd770 Compare July 28, 2020 16:07

SanketDG suggested changes Aug 10, 2020

View reviewed changes

husainattar added 2 commits August 11, 2020 22:32

fix: Update docker file

a6e7d7b

fix: Update docker-compose

b3f367f

Fix the indentation with power of 2's as required.

Merge branch 'develop' into dockerImage

3f0a486

sakshi1499 removed the Status: Changes Requested Changes are required to be done by the PR author. label Aug 13, 2020

sakshi1499 added Status: Changes Requested Changes are required to be done by the PR author. and removed Status: Needs Review PR needs an additional review or a maintainer's review. labels Sep 10, 2020

sakshi1499 added the Status: On Hold Issue or PR needs more info, a discussion, a review or approval from a Maintainer/Code Owner. label Oct 16, 2020

Uh oh!

Conversation

husainattar commented Jul 22, 2020

Description

Type of Change:

How Has This Been Tested?

Checklist:

Uh oh!

sakshi1499 commented Jul 24, 2020

Uh oh!

husainattar commented Jul 24, 2020

Uh oh!

sakshi1499 commented Jul 24, 2020

Uh oh!

husainattar commented Jul 24, 2020

Uh oh!

theyashshahs left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SanketDG commented Jul 24, 2020

Uh oh!

husainattar commented Jul 24, 2020

Uh oh!

SanketDG commented Jul 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

husainattar commented Jul 27, 2020

Uh oh!

SanketDG commented Jul 28, 2020

Uh oh!

husainattar commented Jul 28, 2020

Uh oh!

SanketDG left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

husainattar Aug 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

husainattar Aug 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

husainattar commented Aug 11, 2020

Uh oh!

rajpratik71 commented Aug 20, 2020

Uh oh!

rajpratik71 commented Aug 20, 2020

Uh oh!

theyashshahs left a comment •

edited

Loading

SanketDG commented Jul 27, 2020 •

edited

Loading

husainattar Aug 10, 2020 •

edited

Loading

husainattar Aug 10, 2020 •

edited

Loading