Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deployment troubleshooting #892

Merged
merged 3 commits into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/plone-deployment/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ This guide outlines the steps to deploy the project using a Docker stack compris

You can find this stack at {file}`devops/stacks/ploneconf2024-<your-github-username>.tangrama.com.br.yml`. It's modular, allowing easy integration of additional services like {term}`Varnish`, `Solr`, or `ElasticSearch`.

```{seealso}
[Traefik Proxy with HTTPS](https://dockerswarm.rocks/traefik/)
```

## Building Docker Images

Ensure you build the Docker images for the Frontend and Backend servers before deployment. GitHub Actions, configured in {file}`.github/workflows/backend.yml` and {file}`.github/workflows/frontend.yml`, facilitate this process.
Expand Down
1 change: 1 addition & 0 deletions docs/plone-deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,5 @@ project-edit
server-setup
deploy
virtual-host
troubleshoot
```
2 changes: 1 addition & 1 deletion docs/plone-deployment/project-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ git remote add origin [email protected]:<your-github-username>/ploneconf2024.git
git branch -M main
```

### 4. Push to GitHub
### 5. Push to GitHub

Push your commits to the remote repository hosted on GitHub. This command will trigger the GitHub Actions that test the codebase and
generate Docker images for the Backend and for the Frontend.
Expand Down
36 changes: 36 additions & 0 deletions docs/plone-deployment/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
myst:
html_meta:
"description": "Troubleshoot Plone Deployment issues"
"property=og:description": "Troubleshoot Plone Deployment issues"
"property=og:title": "Troubleshoot Plone Deployment issues"
"keywords": "Plone, Deployment, Stack, Configuration, Guide, Troubleshoot"
---

# Troubleshoot deployment issues

This page offers some tips to troubleshoot the Plone Deployment Training.

## Docker `Could not create directory.`

Docker requires sufficient virtual disk space to install and build images.
A typical error message may be `Could not create directory.` or anything else that mentions writing to the image.
To resolve this, use an appropriate `docker system prune` option, such as `docker system prune -a`.

```{seealso}
[`docker system prune`](https://docs.docker.com/engine/reference/commandline/system_prune/)
```

You can also configure settings for Docker Desktop.
Under {menuselection}`Prefences --> Resources --> Advanced`, you can configure appropriate settings for virtual disk limit and memory.

```{seealso}
- [Change Docker Desktop settings](https://docs.docker.com/desktop/settings-and-maintenance/settings/)
```


## Docker memory usage

Docker requires sufficient memory to install and build images.
2GB of RAM is usually sufficient.
See the previous section for settings details.