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

Bump tag references from 14 to 15 #17096

Merged
merged 2 commits into from
Nov 12, 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
2 changes: 1 addition & 1 deletion docs/development/packaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The packager.io website observes changes in the repository through webhooks and

- `dev`: https://packager.io/gh/opf/openproject
- `release/*` (e.g.,) https://packager.io/gh/opf/openproject/refs/release/13.0
- `stable/*` (e.g.,) https://packager.io/gh/opf/openproject/refs/stable/14
- `stable/*` (e.g.,) https://packager.io/gh/opf/openproject/refs/stable/15
- `packaging/*`

To see the status of a build, simply follow one of the links and choose a distribution whose logs you want to look at.
Expand Down
8 changes: 4 additions & 4 deletions docs/installation-and-operations/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ volumes:
x-op-restart-policy: &restart_policy
restart: unless-stopped
x-op-image: &image
image: openproject/openproject:${TAG:-14}
image: openproject/openproject:${TAG:-15}
x-op-app: &app
<<: [*image, *restart_policy]
environment:
Expand All @@ -77,7 +77,7 @@ x-op-app: &app
- "${OPDATA:-opdata}:/var/openproject/assets"

# configuration cut off at this point.
# Please use the file at https://github.com/opf/openproject-deploy/blob/stable/14/compose/docker-compose.yml
# Please use the file at https://github.com/opf/openproject-deploy/blob/stable/15/compose/docker-compose.yml
```

Alternatively, you can also use an env file for docker-compose like so:
Expand All @@ -104,15 +104,15 @@ volumes:
x-op-restart-policy: &restart_policy
restart: unless-stopped
x-op-image: &image
image: openproject/openproject:${TAG:-14}
image: openproject/openproject:${TAG:-15}
x-op-app: &app
<<: [*image, *restart_policy]
environment:
OPENPROJECT_HTTPS: ${OPENPROJECT_HTTPS}
# ... more environment variables

# configuration cut off at this point.
# Please use the file at https://github.com/opf/openproject-deploy/blob/stable/14/compose/docker-compose.yml
# Please use the file at https://github.com/opf/openproject-deploy/blob/stable/15/compose/docker-compose.yml
```

Let's say you have a `.env.prod` file with some production-specific configuration. Then, start the services with that special env file specified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ point to an external database.
Example:

```shell
docker run -d ... -e DATABASE_URL=postgres://user:pass@host:port/dbname openproject/openproject:14
docker run -d ... -e DATABASE_URL=postgres://user:pass@host:port/dbname openproject/openproject:15
```

Best practice is using the file `docker-compose.override.yml`. If you run the Compose based docker stack, you can simply override the `DATABASE_URL` environment variable, and remove the `db` service from the `docker-compose.yml` file, but because by pulling a new version `docker-compose.yml` might get replaced. Then you can restart the stack with:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ services:
web: &openproject
environment:
- DATABASE_URL=postgres://postgres:p4ssw0rd@database/openproject
image: openproject/openproject:14
image: openproject/openproject:15
command: ./docker/web
worker:
<<: *openproject
Expand Down
46 changes: 23 additions & 23 deletions docs/installation-and-operations/installation/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ docker run -it -p 8080:80 \
-e OPENPROJECT_HOST__NAME=localhost:8080 \
-e OPENPROJECT_HTTPS=false \
-e OPENPROJECT_DEFAULT__LANGUAGE=en \
openproject/openproject:14
openproject/openproject:15
```

Explanation of the used configuration values:
Expand Down Expand Up @@ -106,7 +106,7 @@ docker run -d -p 8080:80 \
-e OPENPROJECT_SECRET_KEY_BASE=secret \
-e OPENPROJECT_HOST__NAME=localhost:8080 \
-e OPENPROJECT_HTTPS=false \
openproject/openproject:14
openproject/openproject:15
```

**Note**: We've had reports of people being unable to start OpenProject this way
Expand Down Expand Up @@ -138,7 +138,7 @@ docker run -d -p 8080:80 --name openproject \
-e OPENPROJECT_SECRET_KEY_BASE=secret \
-v /var/lib/openproject/pgdata:/var/openproject/pgdata \
-v /var/lib/openproject/assets:/var/openproject/assets \
openproject/openproject:14
openproject/openproject:15
```

Please make sure you set the correct public facing hostname in `OPENPROJECT_HOST__NAME`. If you don't have a load-balancing or proxying web server in front of your docker container,
Expand Down Expand Up @@ -395,7 +395,7 @@ end
**3. Create the `Dockerfile`** in the same folder. The contents have to look like this:

```dockerfile
FROM openproject/openproject:14
FROM openproject/openproject:15

# If installing a local plugin (using `path:` in the `Gemfile.plugins` above),
# you will have to copy the plugin code into the container here and use the
Expand All @@ -419,7 +419,7 @@ All the Dockerfile does is copy your custom plugins gemfile into the image, inst
If you are using the `-slim` tag you will need to do the following to add your plugin.

```dockerfile
FROM openproject/openproject:14 AS plugin
FROM openproject/openproject:15 AS plugin

# If installing a local plugin (using `path:` in the `Gemfile.plugins` above),
# you will have to copy the plugin code into the container here and use the
Expand All @@ -434,7 +434,7 @@ COPY Gemfile.plugins /app/
RUN bundle config unset deployment && bundle install && bundle config set deployment 'true'
RUN ./docker/prod/setup/precompile-assets.sh

FROM openproject/openproject:14-slim
FROM openproject/openproject:15-slim

COPY --from=plugin /usr/bin/git /usr/bin/git
COPY --chown=$APP_USER:$APP_USER --from=plugin /app/vendor/bundle /app/vendor/bundle
Expand All @@ -458,7 +458,7 @@ The `-t` option is the tag for your image. You can choose what ever you want.
**5. Run the image**

You can run the image just like the normal OpenProject image (as shown [here](#quick-start)).
You just have to use your chosen tag instead of `openproject/openproject:14`.
You just have to use your chosen tag instead of `openproject/openproject:15`.
To just give it a quick try you can run this:

```shell
Expand All @@ -480,26 +480,26 @@ sudo docker run -it -p 8080:80 \
-e OPENPROJECT_DEFAULT__LANGUAGE=en \
--mount type=bind,source=$(pwd)/my_root.crt,target=/tmp/my_root.crt \ #mount my_root.crt to /tmp
-e SSL_CERT_FILE=/tmp/my_root.crt \ #set the SSL_CERT_FILE to the path of my_root.crt
openproject/openproject:14
openproject/openproject:15
```

The second way would be to build a new image of the ```openproject/openproject:14``` or the ```-slim``` image.
The second way would be to build a new image of the ```openproject/openproject:15``` or the ```-slim``` image.

**1. Create a new folder** with any name, for instance `custom-openproject`. Change into that folder.

**2. Put your root SSL certificate** into the folder. In this example, we will name it ```my_root.crt```.

**3. Create the `Dockerfile`** in the same folder. The contents have to look like this:
```dockerfile
FROM openproject/openproject:14
FROM openproject/openproject:15

COPY ./my_root.crt /usr/local/share/ca-certificates/
RUN update-ca-certificates
```

If you are using the -slim tag, you will need to do the following to import your root certificate:
```dockerfile
FROM openproject/openproject:14-slim
FROM openproject/openproject:15-slim

USER root
COPY ./smtp.local_rootCA.crt /usr/local/share/ca-certificates/
Expand All @@ -516,7 +516,7 @@ The `-t` option is the tag for your image. You can choose what ever you want.

**5. Run the image**

You can run the image just like the normal OpenProject image (as shown [here](#quick-start)). You just have to use your chosen tag instead of ```openproject/openproject:14```
You can run the image just like the normal OpenProject image (as shown [here](#quick-start)). You just have to use your chosen tag instead of ```openproject/openproject:15```

## Offline/air-gapped installation

Expand All @@ -528,7 +528,7 @@ The installation works the same as described above. The only difference is that
On a system that has access to the internet run the following.

```shell
docker pull openproject/openproject:14 && docker save openproject/openproject:14 | gzip > openproject-12.tar.gz
docker pull openproject/openproject:15 && docker save openproject/openproject:15 | gzip > openproject-stable.tar.gz
```

This creates a compressed archive containing the latest OpenProject docker image.
Expand Down Expand Up @@ -729,12 +729,12 @@ Once this has finished you should see something like this when running `docker s
docker service ls
ID NAME MODE REPLICAS IMAGE PORTS
kpdoc86ggema openproject_cache replicated 1/1 memcached:latest
qrd8rx6ybg90 openproject_cron replicated 1/1 openproject/openproject:14
qrd8rx6ybg90 openproject_cron replicated 1/1 openproject/openproject:15
cvgd4c4at61i openproject_db replicated 1/1 postgres:13
uvtfnc9dnlbn openproject_proxy replicated 1/1 openproject/openproject:14 *:8080->80/tcp
g8e3lannlpb8 openproject_seeder replicated 0/1 openproject/openproject:14
canb3m7ilkjn openproject_web replicated 1/1 openproject/openproject:14
7ovn0sbu8a7w openproject_worker replicated 1/1 openproject/openproject:14
uvtfnc9dnlbn openproject_proxy replicated 1/1 openproject/openproject:15 *:8080->80/tcp
g8e3lannlpb8 openproject_seeder replicated 0/1 openproject/openproject:15
canb3m7ilkjn openproject_web replicated 1/1 openproject/openproject:15
7ovn0sbu8a7w openproject_worker replicated 1/1 openproject/openproject:15
```

You can now access OpenProject under `http://0.0.0.0:8080`.
Expand Down Expand Up @@ -772,12 +772,12 @@ This will take a moment to converge. Once done you should see something like the
docker service ls
ID NAME MODE REPLICAS IMAGE PORTS
kpdoc86ggema openproject_cache replicated 1/1 memcached:latest
qrd8rx6ybg90 openproject_cron replicated 1/1 openproject/openproject:14
qrd8rx6ybg90 openproject_cron replicated 1/1 openproject/openproject:15
cvgd4c4at61i openproject_db replicated 1/1 postgres:10
uvtfnc9dnlbn openproject_proxy replicated 2/2 openproject/openproject:14 *:8080->80/tcp
g8e3lannlpb8 openproject_seeder replicated 0/1 openproject/openproject:14
canb3m7ilkjn openproject_web replicated 6/6 openproject/openproject:14
7ovn0sbu8a7w openproject_worker replicated 1/1 openproject/openproject:14
uvtfnc9dnlbn openproject_proxy replicated 2/2 openproject/openproject:15 *:8080->80/tcp
g8e3lannlpb8 openproject_seeder replicated 0/1 openproject/openproject:15
canb3m7ilkjn openproject_web replicated 6/6 openproject/openproject:15
7ovn0sbu8a7w openproject_worker replicated 1/1 openproject/openproject:15
```

Docker swarm handles the networking necessary to distribute the load among the nodes.
Expand Down
14 changes: 7 additions & 7 deletions docs/installation-and-operations/installation/packaged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Add the OpenProject package source:

```shell
sudo wget -O /etc/apt/sources.list.d/openproject.list \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/ubuntu/22.04.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/ubuntu/22.04.repo
```

Download the OpenProject package:
Expand Down Expand Up @@ -99,7 +99,7 @@ Add the OpenProject package source:

```shell
sudo wget -O /etc/apt/sources.list.d/openproject.list \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/ubuntu/20.04.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/ubuntu/20.04.repo
```

Download the OpenProject package:
Expand Down Expand Up @@ -133,7 +133,7 @@ Add the OpenProject package source:

```shell
wget -O /etc/apt/sources.list.d/openproject.list \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/debian/12.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/debian/12.repo
```

Download the OpenProject package:
Expand Down Expand Up @@ -165,7 +165,7 @@ Add the OpenProject package source:

```shell
wget -O /etc/apt/sources.list.d/openproject.list \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/debian/11.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/debian/11.repo
```

Download the OpenProject package:
Expand All @@ -185,7 +185,7 @@ Add the OpenProject package source:

```shell
sudo wget -O /etc/yum.repos.d/openproject.repo \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/el/9.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/el/9.repo
```

If it is not already enabled, make sure to enable [Extra Packages for Enterprise Linux](https://fedoraproject.org/wiki/EPEL) (EPEL).
Expand Down Expand Up @@ -216,7 +216,7 @@ Add the OpenProject package source:

```shell
sudo wget -O /etc/yum.repos.d/openproject.repo \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/el/8.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/el/8.repo
```

If it is not already enabled, make sure to enable [Extra Packages for Enterprise Linux](https://fedoraproject.org/wiki/EPEL) (EPEL).
Expand Down Expand Up @@ -260,7 +260,7 @@ Add the OpenProject package source:

```shell
wget -O /etc/zypp/repos.d/openproject.repo \
https://dl.packager.io/srv/opf/openproject/stable/14/installer/sles/15.repo
https://dl.packager.io/srv/opf/openproject/stable/15/installer/sles/15.repo
```

If you already had an old package source that is being updated you must refresh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This means OpenProject has to be used exactly as described in the [docker](../do
Launching OpenProject works like launching any other container in [Synology](https://www.synology.com/en-global/knowledgebase/DSM/help/Docker/docker_container).

First you have to go to the **Registry** section and download the OpenProject image.
It's best to choose the specific tag of the latest stable version (`openproject/openproject:14` at the time of writing).
It's best to choose the specific tag of the latest stable version (`openproject/openproject:15` at the time of writing).
You can use `:latest` too but it might lead to surprises when a major version upgrade happens.

Below are some settings you have to pay attention to when launching the container.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ sudo yum remove pgsql10
> Please follow this section only if you have installed OpenProject using [this procedure](../../installation/docker/).
> Before attempting the upgrade, please ensure you have performed a backup of your installation by following the [backup guide](../../operation/backing-up/).

You can find the upgrade instructions for your docker-compose setup in the [openproject-deploy](https://github.com/opf/openproject-deploy/blob/stable/14/compose/control/README.md#upgrade) repository.
You can find the upgrade instructions for your docker-compose setup in the [openproject-deploy](https://github.com/opf/openproject-deploy/blob/stable/15/compose/control/README.md#upgrade) repository.

Remember that you need to have checked out that repository and work in the `compose` directory for the instructions to work.

Expand All @@ -188,7 +188,7 @@ Once the docker has stopped, you are ready to run the upgrade command. In this c
docker run --rm -it \
-v /var/lib/openproject/pgdata:/var/openproject/pgdata \
-v /var/lib/openproject/pgdata-next:/var/openproject/pgdata-next \
openproject/openproject:14 root ./docker/prod/postgres-db-upgrade
openproject/openproject:15 root ./docker/prod/postgres-db-upgrade
```

If everything goes well, the process should end with a message as follows:
Expand Down Expand Up @@ -217,7 +217,7 @@ docker run -d -p 8080:80 --name openproject -e SECRET_KEY_BASE=secret \
-v /var/lib/openproject/pgdata:/var/openproject/pgdata \
-v /var/lib/openproject/assets:/var/openproject/assets \
[...]
openproject/openproject:14
openproject/openproject:15

If your new installation looks fine, you can then choose to remove `/var/lib/openproject/pgdata-prev`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ sudo mkdir -p /var/lib/openproject/{pgdata,assets}
docker run -d -p 8080:80 --name openproject -e SECRET_KEY_BASE=secret \
-v /var/lib/openproject/pgdata:/var/openproject/pgdata \
-v /var/lib/openproject/assets:/var/openproject/assets \
openproject/openproject:14
openproject/openproject:15
```

Then you would need to backup the `/var/lib/openproject` folder (for instance to S3 or FTP server).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ mkdir -p /var/lib/openproject/{pgdata,assets}
Next we need to initialize the database.

```shell
docker run --rm -v /var/lib/openproject/pgdata:/var/openproject/pgdata -it openproject/openproject:14
docker run --rm -v /var/lib/openproject/pgdata:/var/openproject/pgdata -it openproject/openproject:15
```

As soon as you see `Database setup finished.` in the container's output you can kill it by pressing Ctrl + C.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ sudo openproject configure

On Ubuntu 22.04., you might see warnings like these:

> W: https://dl.packager.io/srv/deb/opf/openproject/stable/14/ubuntu/dists/22.04/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
> W: https://dl.packager.io/srv/deb/opf/openproject/stable/15/ubuntu/dists/22.04/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.

This message is due to Ubuntu 22.04 switching to a more secure way of adding repository sources, which is not yet supported by the repository provider. There is ongoing work on this item, the message is for information only.

If you get an error like the following:

> E: Repository 'https://dl.packager.io/srv/deb/opf/openproject/stable/14/ubuntu 22.04 InRelease' changed its 'Origin' value from '' to 'https://packager.io/gh/opf/openproject'
> E: Repository 'https://dl.packager.io/srv/deb/opf/openproject/stable/14/ubuntu 22.04 InRelease' changed its 'Label' value from '' to 'Ubuntu 22.04 packages for opf/openproject'
> E: Repository 'https://dl.packager.io/srv/deb/opf/openproject/stable/15/ubuntu 22.04 InRelease' changed its 'Origin' value from '' to 'https://packager.io/gh/opf/openproject'
> E: Repository 'https://dl.packager.io/srv/deb/opf/openproject/stable/15/ubuntu 22.04 InRelease' changed its 'Label' value from '' to 'Ubuntu 22.04 packages for opf/openproject'

These two messages messages are expected, due to a change in Origin and Label repository metadata, to better explain what the repository is about. You should allow the change, and/or run `sudo apt-get update --allow-releaseinfo-change` for the update to go through.

Expand Down Expand Up @@ -117,7 +117,7 @@ When using the all-in-one docker container, you need to perform the following st

```shell
docker pull openproject/openproject:VERSION
# e.g. docker pull openproject/openproject:14
# e.g. docker pull openproject/openproject:15
```

Then stop and remove your existing container (we assume that you are running with the recommended production setup here):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ It's best to monitor your server and its resource usage. You can always allocate

See [here](../operation/control/#scaling-the-number-of-web-workers) how to scale those up in a packaged installation. If you are using docker-compose you can [scale](https://docs.docker.com/compose/reference/scale/) the web and worker services too.

> <sup>1</sup> When using [docker-compose](https://github.com/opf/openproject-deploy/tree/stable/14/compose) (with `USE_PUMA=true`) you can use fewer web workers which may use a bit more RAM, however. For instance for 200 users a single web worker would be enough.
> <sup>1</sup> When using [docker-compose](https://github.com/opf/openproject-deploy/tree/stable/15/compose) (with `USE_PUMA=true`) you can use fewer web workers which may use a bit more RAM, however. For instance for 200 users a single web worker would be enough.

**Scaling horizontally**

Expand Down
Loading
Loading