Talawa-Admin Docker Support Issue

[duplixx]

Talawa-Admin Docker Support Issue:

Title:
Adding Docker Support to Talawa-Admin

Description:

Problem:
Talawa-Admin currently lacks Docker support, hindering its ease of deployment and scalability. Adding Docker support is essential to streamline the deployment process and make it more accessible to a broader audience.

Solution:
Implementing Docker support for Talawa-Admin would involve creating a Dockerfile and configuration to package the application into a Docker container. This containerization would simplify deployment, improve consistency across environments, and enhance scalability.

Approach:
To achieve Docker support for Talawa-Admin, we can follow these steps:

1. Create a Dockerfile specifying the necessary dependencies and configuration.
2. Configure the application to work seamlessly within a Docker container.
3. Document the steps for building and running Talawa-Admin using Docker in the project's README.

Additional Context:
Adding Docker support aligns with modern development practices, making it easier for developers to set up and run Talawa-Admin in various environments. Docker containers provide isolation, portability, and reproducibility, contributing to a more robust and user-friendly development and deployment experience.

Potential internship candidates
Please read this if you are planning to apply for a Palisadoes Foundation internship PalisadoesFoundation/talawa#359

[duplixx]

Hey @palisadoes please assign me this issue.
Thanks !!

[noman2002]

@duplixx Do we even need docker on the admin? If yes, please explain why we need it.

[duplixx]

Hey @noman2002 , I strongly believe that integrating Docker into Talawa-Admin is essential. It effectively addresses significant challenges faced by developers and contributors.

• Reduces Setup Issues for Contributors:

  • Docker ensures a standardized environment, minimizing setup issues for contributors.
  • Facilitates a more consistent development environment for everyone involved.

• Eliminates "It Works on My Machine" Problem:

  • Docker eliminates the common challenge of code working differently on different machines.
  • Developers can confidently share and collaborate on the same codebase without encountering environment-related discrepancies.

• Ensures Consistency Across Environments:

  • Talawa-Admin benefits from consistent environments across development, testing, and production.
  • Docker ensures that the application behaves uniformly, mitigating issues related to environment variations.

• Confident Collaboration:

  • Developers can work on the same codebase without concerns about environment differences.
  • Docker fosters confident collaboration, enabling a smoother development process.

In summary, leveraging Docker in Talawa-Admin significantly improves collaboration, consistency, and reduces common challenges associated with environment setups.

[aashimawadhwa]

@kb-0311 @beingnoble03 @DMills27 @EshaanAgg would like to hear your thoughts on this.

[DMills27]

Docker is essentially being used as a stop gap, at the moment, until we can put in place a more sustainable means to achieve reproducibility. I propose we have a single Docker image that generates the API, Admin and Talawa Mobile Frontend. My reasoning is that it would incur additional complexity to create separate Docker images for these and then connect them; it is also inefficient in terms of computational resources that would be used.

[palisadoes]

@DMills27

1. You mean API and the web Admin/User portal correct?
2. How would we best approach this if we are using separate repos for the API and Admin?

[aarishshahmohsin]

I could make a dockerfile for Talawa-Admin. I there is a need, Please assign this issue to me.

[duplixx]

@DMills27

1. You mean API and the web Admin/User portal correct?
2. How would we best approach this if we are using separate repos for the API and Admin?

In my view we should follow this approach

1. Dockerfile for Each Component

• Create a Dockerfile for API and Admin.
• Specify base images with necessary dependencies.

2. Docker Compose for Multi-Container Setup

• Use Docker Compose for a multi-container setup.
• Define services, networks, and volumes in docker-compose.yml.

3. Service Orchestration

• Define dependencies between services.
• Use container names for inter-service communication.

[noman2002]

@DMills27 @palisadoes Is this issue required or should we close this for now ??

[EshaanAgg]

It would only make sense for this issue if we publish the Talawa-API as a docker image on DockerHub, and then use it to setup the admin via Compose. Otherwise there is no need for the same as of now IMO.

[noman2002]

Thanks @EshaanAgg .
Closing this for now.

[palisadoes]

@EshaanAgg As you spoke about publishing Talawa* on Docker Hub, should we reopen this issue?

[EshaanAgg]

We are yet to make a docker image for Talawa APi. It would be apt to reopen the same after it.

[palisadoes]

We are yet to make a docker image for Talawa APi. It would be apt to reopen the same after it.

The API got its docker instance created about 2 weeks ago. So we should reopen this issue.

[Gmin2]

can i get assigned?

[Gmin2]

@EshaanAgg @noman2002 is the talawa image is published on dockerhub i cant see it?

[shankeleven]

@palisadoes please assign this issue to me, would love to work

[Devesh326]

@palisadoes can i work on this issue!

[Devesh326]

Hey @aashimawadhwa and @palisadoes

I'm currently working on dockerizing Talawa Admin. To set up the Docker Compose file, I need the Docker image for Talawa API, but I couldn't find it anywhere.

Could you please guide me in the right direction or provide information about where I can obtain the Talawa API Docker image?

Thanks!

[palisadoes]

1. You'll need to assume that the API is up and running.
2. You will also need to update the setup script to accommodate the Docker support you'll be adding
   • Create a Setup Script for the .env configuration file #1233

[Devesh326]

Okay, thanks!

[vasujain275]

I have raised the PR for the Docker Support in Talawa Admin, here is the Summary of the changes -

1. Introduction of Docker Support:

• This PR adds Docker support to Talawa Admin.
• This enhancement aims to facilitate a smoother developer experience, especially for individuals contributing to Talawa API and Talawa App.

2. Consideration of Docker Methods:

• Initially, the idea was to implement two Docker methods - dev and production.
• However, upon scrutinizing the codebase, it was discovered that we are utilizing Create React App and react scripts for the build process.
• The current build process is evidently not optimized for either production-ready minified binaries or Docker hot reloading.

3. Proposal for Build Process Improvement:

• To address this limitation, I think we should migrate to a more suitable build process like Vite.
• This migration is necessary to enable efficient building of both minified production-ready build files and Docker hot reloading.

4. Planned Actions:

• After this PR is merged, I will raise an issue to migrate from React scripts to the Vite build process, we can have further discussion on build process there.
• This action will lay the groundwork for future improvements in better and improved Docker support once the Build Process is sorted.

5. Current Status:

• Currently, separate dev and prod Docker methods have not been implemented due to the inadequacy of the existing build process.
• The current build process cannot produce minified production-ready build files, and a dev hot reloading Docker setup would be impractical due to the same issue.

@kb-0311 @noman2002 @palisadoes I highly recommand to migrate to VIte Build process, it will make our build process so much efficient, faster, simplified. I would appreciate your insights on this.

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

[vasujain275]

@Cioppolo14 Any update on pr review?

[Cioppolo14]

@vasujain275 Sorry for the delay, I am back on it. I will follow up soon. Feel free to find me on slack too.

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

[Cioppolo14]

I am working on the review. Starting with API and working my way through.

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

[VanshikaSabharwal]

@palisadoes I understand that the primary goal of the PR is to ensure the correct startup of Talawa-Admin within a Docker container, which is a valuable addition to the workflow. However, I believe that creating a Dockerfile for Talawa-Admin would significantly enhance its deployment and scalability. This would allow for a more self-contained and easily deployable application

[VanshikaSabharwal]

@palisadoes @DMills27 @noman2002 @varshith257 I'm open to collaborating with you and other contributors to implement Docker support for Talawa-Admin. We can discuss specific strategies and potential challenges.

Please let me know if you have any questions or require further assistance.

[VanshikaSabharwal]

Is this Dockerfile GTG or should i add something more.

[varshith257]

@VanshikaSabharwal You can refer the previous attempt made which is close to what we need

#1726

[VanshikaSabharwal]

@VanshikaSabharwal You can refer the previous attempt made which is close to what we need

#1726

Okay i get it

[VanshikaSabharwal]

I was facing this issue while running docker file locally for talawa-admin.

. So i had to modify this file vite.config.ts file.
Before.

After

. After making above changes i am now able to run Docker file for talawa-admin.

SO should i raise PR now??

[palisadoes]

If the problem is fixed, please open the PR

[palisadoes]

During the week of November 11, 2024 we will start a code freeze on the develop branches in Talawa, Talawa Admin and Talawa-API.

We have completed a project to convert the Talawa-API backend to use PostgreSQL. Work will then begin with us merging code in the develop branches to a new develop-postrgres branch in each repository.

Planning activities for this will be managed in our #talawa-projects slack channel. A GitHub project will be created to track specially labeled issues. We completed a similar exercise last year using a similar methodology.

Starting November 12, California time no new PRs will be accepted against the develop branch. They must be applied to the develop-postrgres branch.

There are some GSoC project features that will need to be merged into develop. These will be the only exceptions.

This activity and the post GSoC 2024 start date was announced in our #general Slack channel last month as a pinned post.

[VanshikaSabharwal]

If the problem is fixed, please open the PR

Yes, This PR solves the issue. #2414