Skip to content

Commit 1238580

Browse files
Carry the RC1 tester fixes over to the 1.0 install pages (#85)
* Close the gaps RC1 testers hit on the release-candidate page Five independent first-time-user runs hit the same walls: the container command needs credentials the page never set, the installer stalls at a sudo password on cloud users, nothing showed how to connect, the 752 workaround read a file that didn't exist, and cleanup had no commands. Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> * Drop 'disposable' from the RC host requirement Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> * Move the RC1 tester fixes that still apply to the 1.0 pages --------- Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> Co-authored-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> Co-authored-by: Guanzhou Song <guanzhousong@microsoft.com>
1 parent e1e5592 commit 1238580

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

‎getting-started/prebuilt-packages.md‎

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,21 @@ and runs setup:
3333

3434
```sh
3535
curl -fsSLo documentdb-install.sh https://documentdb.io/install.sh &&
36-
sh documentdb-install.sh
36+
sudo sh documentdb-install.sh
3737
```
3838

39-
This installs the current release on PostgreSQL 18. Use `--pg-major 17` for PostgreSQL 17.
39+
This installs the current release on PostgreSQL 18. Use `--pg-major 17` for PostgreSQL 17. Run it with `sudo`: started as a normal user, it calls `sudo -v`, which asks for a password even on cloud images whose default user has passwordless sudo.
40+
41+
It asks you to confirm the plan and to choose the admin password. For an unattended run, store the password in a root-owned file and pass `--yes`:
42+
43+
```sh
44+
printf 'DocumentDB admin password: '; IFS= read -r -s PW; echo
45+
printf '%s\n' "$PW" | sudo install -m 600 /dev/stdin /root/documentdb-admin.pw
46+
sudo sh documentdb-install.sh --yes \
47+
--admin-password-file /root/documentdb-admin.pw --accept-external-listen
48+
```
49+
50+
`--accept-external-listen` acknowledges that the gateway listens on all interfaces.
4051
The manual steps below install the same release. To move an existing installation to 1.0, see [Upgrading to 1.0](#upgrading-to-10) instead.
4152

4253
## Set up and connect
@@ -80,7 +91,7 @@ Enter the password set in the wizard, then run:
8091
db.runCommand({ ping: 1 })
8192
```
8293

83-
The local example accepts the generated self-signed certificate. A bare `-p` prompts for a password; non-interactive scripts must supply a password explicitly.
94+
The local example accepts the generated self-signed certificate. A bare `-p` prompts for a password; non-interactive scripts must supply a password explicitly. `db.version()` reports the MongoDB version DocumentDB is compatible with, not the DocumentDB version; see [Check the version](#check-the-version).
8495

8596
### Optional setup controls
8697

@@ -95,6 +106,18 @@ The local example accepts the generated self-signed certificate. A bare `-p` pro
95106

96107
Inspect state with `sudo documentdb-setup --pg-version 18 --status`. On systemd, restart this stack with `sudo systemctl restart documentdb-local@18.target`; adopted PostgreSQL retains its own lifecycle. See [Operating a package install](https://documentdb.io/docs/linux-packages/) for TLS and other operational guidance.
97108

109+
### Remove the stack
110+
111+
Delete the instance first, then the packages. `documentdb-local-reset` ships in `documentdb-common`, so it has to run before the purge; purging alone keeps the data directory.
112+
113+
```bash
114+
sudo documentdb-local-reset --pg-version 18 --confirm-destroy
115+
sudo apt purge -y '*documentdb*' # Ubuntu
116+
sudo dnf remove -y '*documentdb*' # EL9
117+
```
118+
119+
The reset is irreversible and only covers the stand-alone stack's private instance, not an adopted PostgreSQL. Open remove and purge problems are tracked in [#771](https://github.com/documentdb/documentdb/issues/771).
120+
98121
## What each release publishes
99122

100123
`N` is the PostgreSQL major version. The package manager installs the dependencies of your selected package.

‎getting-started/release-notes-1.0.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ The SQL extension version is `1.0-0` everywhere, and `hello` reports it in `inte
5454
- **A write can be applied twice** ([#767](https://github.com/documentdb/documentdb/issues/767)). If the backend connection is lost after a write commits but before the reply, the gateway retries it, so a non-idempotent update such as `$inc` can be applied twice even with `retryWrites=false`.
5555
- **`$lookup` can fail on a collection with a wildcard index** ([#769](https://github.com/documentdb/documentdb/issues/769)), with `Unrecognized BSON data type code 0`.
5656
- **Collation is off by default.** `find`, `aggregate`, `count` and `delete` with a `collation` fail as unsupported unless `documentdb_core.enableCollation` is on. `distinct`, `findAndModify` and `update` don't support `collation` at all.
57+
- **Harmless errors in the container log.** The health check logs `FATAL: database "documentdb" does not exist` about every 30 seconds, and startup logs one `Failed to accept a TCP connection (IPv6)` error. Neither affects the server.
5758
- **Container options that do nothing.** `--log-level` and `--enable-telemetry` are validated but have no effect, and a `--data-path` that contains a space fails.
5859
- **Open packaging and container issues:**
5960
- [#771](https://github.com/documentdb/documentdb/issues/771): package remove, purge, upgrade and rerun paths that can leave the stack down or stuck.

0 commit comments

Comments
 (0)