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

RDoc-2454_ver6-dockerChanges #1665

Merged
merged 7 commits into from
Jun 27, 2023

Conversation

reebhub
Copy link
Contributor

@reebhub reebhub commented Jun 12, 2023

RavenDB docker documentation updates

@reebhub reebhub requested a review from gregolsky June 25, 2023 14:07
using a dedicated user rather than `root`.
RavenDB `6.0` and up also use a Debian archive file
([.deb package](../../start/installation/gnu-linux/deb)), applying
a uniform internal structure for Ubuntu and Windows Linux versions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is Windows Linux?
Maybe:

Suggested change
a uniform internal structure for Ubuntu and Windows Linux versions.
a uniform internal structure for Ubuntu OS.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

due to CIFS protocol usage.
* **Platforms**
RavenDB images are available for:
* **Ubuntu** (20.04, 18.04, 16.04) or any other Debian-based distribution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Ubuntu** (20.04, 18.04, 16.04) or any other Debian-based distribution.
* **Ubuntu** (22.04, 20.04) or any other Debian-based distribution.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* _Tag_: `windows-1809-latest`
Latest RavenDB version, running on Windows Nano Server version 1809
* _Tag_: `windows-ltsc2022-latest`
Latest RavenDB version, running on Windows Nano Server version 2022
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Latest RavenDB version, running on Windows Nano Server version 2022
Latest RavenDB version, running on Windows Nano Server version LTSC2022

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* _Tag_: `windows-1809-latest-lts`
Latest RavenDB LTS version, running on Windows Nano Server version 1809
* _Tag_: `windows-ltsc2022-latest-lts`
Latest RavenDB LTS version, running on Windows Nano Server version 2022
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Latest RavenDB LTS version, running on Windows Nano Server version 2022
Latest RavenDB LTS version, running on Windows Nano Server version LTSC2022

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

After running the image, access it from a browser using its URL.
By default: `http://localhost:8080`

If the server is not installed yet, connecting it will start the setup wizard.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the server is not installed yet, connecting it will start the setup wizard.
If the server is not installed yet, connecting it will start the Setup Wizard.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

To install using the `latest` tag, and persist the data stored on your
hard disk if the container is removed, you can use:
{CODE-BLOCK:bash}
docker run --rm -d -p 8080:8080 -p 38888:38888 -v c:/RavenDb/Data:/opt/RavenDB/Server/RavenData ravendb/ravendb
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line should probably use new data dir that's used when installed from DEB /var/lib/ravendb.. something

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
docker run --rm -d -p 8080:8080 -p 38888:38888 -v /var/lib/ravendb/data ravendb/ravendb

Comment on lines 129 to 130
* [Ubuntu image Dockerfile](https://github.com/ravendb/ravendb/tree/v5.4/docker/ravendb-ubuntu)
* [Windows Nano Server image Dockerfile](https://github.com/ravendb/ravendb/tree/v5.4/docker/ravendb-nanoserver)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [Ubuntu image Dockerfile](https://github.com/ravendb/ravendb/tree/v5.4/docker/ravendb-ubuntu)
* [Windows Nano Server image Dockerfile](https://github.com/ravendb/ravendb/tree/v5.4/docker/ravendb-nanoserver)
* [Ubuntu image Dockerfile](https://github.com/ravendb/ravendb/tree/v6.0/docker/ravendb-ubuntu)
* [Windows Nano Server image Dockerfile](https://github.com/ravendb/ravendb/tree/v6.0/docker/ravendb-nanoserver)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


#### Changes made in RavenDB `6.0` and up:

The **user** that installs and runs RavenDB `6.0` and up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **user** that installs and runs RavenDB `6.0` and up
The **user** running RavenDB `6.0` and up

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

#### Changes made in RavenDB `6.0` and up:

The **user** that installs and runs RavenDB `6.0` and up
and the **folders structure** used by these versions are
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
and the **folders structure** used by these versions are
and the **directory structure** used by these versions are

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

These changes need to be addressed when migrating from
version `5.x` or lower to version `6.0` and higher.

* RavenDB Docker images up to `5.x`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what's this section about

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved it below the described differences, it looks like this now:

The user that...

  • RavenDB Docker images up to...
  • RavenDB Docker images from...

These differences need to be addressed when migrating from
version 5.x or lower to version 6.0 and higher.

* Permit the `ravendb` user to access the image directory.
The default **UID** (User ID) and **GID** (Group ID)
used by `ravendb` are **999**.
Set the data folder permissions to these values (or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me folder is more of a Windows thing, as in an icon on the desktop. Technically speaking it's a directory.

Suggested change
Set the data folder permissions to these values (or
Set the data directory permissions to these values (or

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed everywhere

* Migrate files and data
The setup process will create the folders structure detailed
[here](../../start/installation/gnu-linux/deb#file-system-locations).
When setup is done, migrate or link the contents stored in the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to include that The script inside the image is going to try to link legacy data dir to the new one automatically.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

 The script within the image will attempt to link the old version's data directory to the new version's data directory automatically.  
 If this attempt fails, an error will be produced.  

 When setup is done, migrate or link the contents stored in the old RavenDB directories to the newly created structure.  
 Most notably, make sure that the data is available in its new location: `/var/lib/ravendb/data`


Safe by default, optimized for efficiency

Build 40040, Version 4.1, SemVer 4.1.4, Commit dc2e9e3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might wanna update these

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

RDoc-2470 - cloud backups are kept in the same geographical region as the backed up data
… in the same geographical location in Europe and the US.
@ppekrol ppekrol merged commit 3dce803 into ravendb:master Jun 27, 2023
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants