redwoodjs / docker Goto Github PK

In the quest 🧙🏻‍♂️ of finding a good path to officially dockerize and support Redwood image(s) we ask for your help.

If you have a production or experimental Docker setup;

1. Kindly share your Dockerfile(s)
2. Bonus points for a PR that adds the implementation to the testing, or indicate if the repository maintainers can bring it in on your behalf. No pressure.

References

• Implementations for current implementations tests and builds.
• Dockerize RedwoodJS on the community forums

Thanks!

I'm also using a similar Docker implementation in production and ran into a busted dependency and was unable to reproduce locally. Figured the production is running a different version (because no .lock file). I understand the .lock is for whole workspace, but copying over may ensure that at least api deps are pinned to the same version as locally.

Just to be clear, we probably want to keep yarn.lock in the last stage of docker build. Just before: https://github.com/redwoodjs/docker/blob/main/docker/standal-ce-nginx/api/Dockerfile#L35

cc: @realStandal

This issue seeks to define what official RedwoodJS Docker images should be supported and maintained by the community.

Production

Discussion on Dockerfiles and it's implementation

Suggestions

1. One image

• yarn rw serve - example standal-cli-both

2. Two images

• api - example standal-ce-nginx, jeliasson-nginx
• web - example standal-ce-nginx, jeliasson-nginx

2. [Adding more as suggestions come in]

Todo

Overall

• Define official image(s) path
• Review and feedback from community and hosting providers
• If possible, use yarn rw-server api over yarn rw serve api

Build tracking

Workflow	Build status
standal-ce-nginx
standal-cli-both
jeliasson-nginx

This issue seeks to define what image name and tags that should be used when building (and publishing images for official releases).

Official releases

Officially supported and built images that would be published to a Container Registry, and registered with e.g. Docker Hub.

Suggestions

1. With redwood prefix

• redwoodjs/redwood:<version>, e.g. redwoodjs/redwood:0.49.1 - both
• redwoodjs/redwood-api:<version>, e.g. redwoodjs/redwood-api:0.49.1 - api
• redwoodjs/redwood-web:<version>, e.g. redwoodjs/redwood-web:0.49.1 - web

2. Without redwood prefix

• redwoodjs/both:<version>, e.g. redwoodjs/both:0.49.1 - both
• redwoodjs/api:<version>, e.g. redwoodjs/api:0.49.1 - api
• redwoodjs/web:<version>, e.g. redwoodjs/web:0.49.1 - web

3. [Adding more as suggestions come in]

Other

• Should images also be build from the main branch, with e.g. :<sha> as tag?

Development

Development/testing built images that would be published to a Container Registry

Suggestions

1. Sha

• redwoodjs/redwood-<implementation name>-[api/both/web]:<sha>, e.g. redwoodjs/redwood-jeliasson-nginx-web:94e75f1
• redwoodjs/redwood-<implementation name>-[api/both/web]:<sha>, e.g. redwoodjs/redwood-standal-ce-nginx-web:94e75f1

2. [Adding more as suggestions come in]

This issue seeks to create a Docker Hub organization.

Short-term

• Reserve a name.

Long-term

• Maybe build and publish the images there.

@thedavidprice Is the creation something you could help with? Unfortunately, Docker Inc being Docker Inc, it looks like they have put an organization behind a paywall. Because of that, I suggest just having an account created which later can be converted into an org. For now, I think we're primarily interested in making sure we reserve a handle.

References

• Teams and Organizations
• Convert an account into an organization

This issue seeks to setup CI pipeline to build, push and publish official release images.

Dependencies

• Minor changes after repository move
• Define image name and tags
• Define official Docker image(s)

Implementation

• Define a baseline workflow template from development findings
  • Prerequisites (environment variables, image tag)
  • Build image
  • Test image
  • Push image to Container Registry
  • Publish image
• Test
• Build on releases 🚀

Things that needs some attention;

• Activate GitHub Container Registry on the redwoodjs org if not already activated
• Setup a new Personal Access Token or something for secret CONTAINER_REGISTRY_PASSWORD
• Update GitHub actions to push images to redwoodjs and maybe rename images
• Verify that build goes thru
• Update documentation

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update docker/setup-buildx-action action to v3
• chore(deps): update yarn to v4
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update babel monorepo (@babel/node, @babel/preset-env)
• chore(deps): update nginx docker tag to v1.25.2
• chore(deps): update yarn to v3.7.0
• chore(deps): update actions/checkout action to v4
• chore(deps): update dependency nodemon to v3
• chore(deps): update dependency ubuntu to v22
• chore(deps): update docker/build-push-action action to v5
• chore(deps): update docker/login-action action to v3
• chore(deps): update node.js to v20
• fix(deps): update react monorepo to v18 (major) (react, react-dom)
• fix(deps): update redwood monorepo to v6 (major) (@redwoodjs/api, @redwoodjs/core, @redwoodjs/forms, @redwoodjs/graphql-server, @redwoodjs/router, @redwoodjs/web)
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency nodemon to v2.0.22

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

I'm triyng to use the example from https://github.com/redwoodjs/docker/blob/main/docker/jeliasson-nginx/web/Dockerfile to deploy to docker and it seems to work fine.

But as soon as I try to access something, that needs to access one of my env variables, it crashes, because the env var is empty.

I patched around a bunch of things, and I can see in docker, that I have the expected env vars via printenv, but I guess redwood needs them in a .env file somewhere at some point?

CC - @jeliasson, @callingmedic911

I noticed in the Actions logs that (at least) the standal-* images aren't using Yarn 3. This issue is to track its implementation, and provide an explanation should any additional steps be needed.

I'm also really interested in the new build-time, as I think installation is the biggest pain-point right now.

Hi there, i am trying to get these files to run: https://github.com/redwoodjs/docker/blob/main/docker/jeliasson-nginx/api/Dockerfile

in my redwood.toml i have these entries:

[web]
  title = "title"
  port = 8910
  apiUrl = "https://api.mywebsite.de"

[api]
  port = 8911

[browser]
  open = true

when i use tese dockerfiles, i can build the container, but get a strange error when running the api container:

2022-12-21T16:57:54.204347334Z yarn run v1.22.19
2022-12-21T16:57:54.350077354Z $ /app/node_modules/.bin/rw-server --port 8911
2022-12-21T16:57:57.568702777Z Starting API and Web Servers...
2022-12-21T16:57:57.614089598Z {"level":30,"time":1671641877609,"pid":26,"hostname":"a0c92d1775a2","side":"web","_":[],"port":8911,"p":8911,"$0":"node_modules/.bin/rw-server","msg":"In configureFastify hook for side: web"}
2022-12-21T16:57:57.669087925Z Importing Server Functions...
2022-12-21T16:58:00.110888784Z /graphql 2441 ms
2022-12-21T16:58:00.111542111Z ...Done importing in 2443 ms
2022-12-21T16:58:00.117260234Z Took 2550 ms
2022-12-21T16:58:00.117534488Z Web server started on http://localhost:8911
2022-12-21T16:58:00.117694618Z API serving from http://localhost:8911
2022-12-21T16:58:00.117860018Z API listening on http://localhost:8911/https://api.mywebsite.de/api/
2022-12-21T16:58:00.118068076Z GraphQL endpoint at /https://api.mywebsite.de/api/graphql
2022-12-21T16:58:00.123536825Z {"level":40,"time":1671641877632,"pid":26,"hostname":"a0c92d1775a2","msg":"\"root\" path \"/app/web/dist\" must exist"}
2022-12-21T16:58:00.123570279Z {"level":30,"time":1671641877643,"pid":26,"hostname":"a0c92d1775a2","side":"api","_":[],"port":8911,"p":8911,"$0":"node_modules/.bin/rw-server","apiRootPath":"/https://api.mywebsite.de/api/","msg":"In configureFastify hook for side: api"}
2022-12-21T16:58:00.123577629Z {"level":30,"time":1671641880122,"pid":26,"hostname":"a0c92d1775a2","msg":"Server listening at http://[::]:8911"}

what is happening here in this line:
2022-12-21T16:58:00.117860018Z API listening on http://localhost:8911/https://api.mywebsite.de/api/
it seems to be somehow overwritten or so... any idea?

Cheers and thanks!

This issue seeks to setup CI pipeline to build and push development/test images.

Dependencies

• Minor changes after repository move
• Define image name and tags

Implementation

• Define a baseline workflow template
  • Prerequisites (environment variables, image tag)
  • Build image
  • Test image
  • Push image to Container Registry
• Align current workflows with new baseline template

This issue seeks to define what docker-compose files should be supported and maintained by the community.

Dependencies

• Define official Docker image(s)

Development

WiP

Production

WiP

References

• ajcwebdev/redwood-docker-compose (💀 dead)
• pi0neerpat

@jeliasson should we consider moving this repo to the RedwoodJS GitHub org? You (and anyone else) could still be the admins. I'm just thinking it might provide greater visibility and findability.

Up to you.

Per the deprecating PR for RW v1.0, rw-api-server is no longer an acceptable entry point.