Repository navigation
feat(nix): publish and install supautils in site profile
#2424
+175
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Site profile | ||
|
|
||
| The `site-env-15`, `site-env-17`, and `site-env-orioledb-17` package sets are deployed to `/nix/var/nix/profiles/site`. They hold supautils, and `activate`. | ||
|
|
||
| ## Publish | ||
|
|
||
| `ami-release-nix.yml` uploads each store path as a string to the shared artifacts bucket, in the object `nix-catalog/<sha>/<system>/site-env-<major>`. Release branches also upload the git sha as a string to `nix-catalog/latest/<system>/site-env-<major>`. The AMI bake installs the store path passed in as `site_env_path` and runs `activate`. | ||
|
|
||
| ## Update | ||
|
|
||
| ```sh | ||
| nix-env --profile /nix/var/nix/profiles/site --set <store path> | ||
| /nix/var/nix/profiles/site/bin/activate | ||
| ``` | ||
|
|
||
| `--set` downloads the closure from the binary cache if it is missing. It then creates the generation link `site-<N>-link` to the store path and repoints the `site` symlink at that link. If it fails, `nix-env` exits with 1 and the profile is unchanged. This holds when the path can't be fetched, isn't a store path, or the profile directory isn't writable. | ||
|
|
||
| `activate` runs after the switch. It prints the library settings configured in `postgresql.conf`, and is idempotent. If it fails, the new generation stays active. Run `activate` again, or roll back. | ||
|
|
||
| New sessions load supautils from the new profile. Open sessions keep the copy they loaded until they reconnect. Postgres does not restart. A restart applies the change to every session at once. The same holds after a rollback. | ||
|
|
||
| ## Roll back | ||
|
|
||
| ```sh | ||
| nix-env --profile /nix/var/nix/profiles/site --rollback | ||
|
brainrake marked this conversation as resolved.
|
||
| /nix/var/nix/profiles/site/bin/activate | ||
| ``` | ||
|
|
||
| Rollback switches to the previous generation. `activate` then runs from that generation and makes the machine match it. There is no separate rollback script. | ||
|
|
||
| To go further back than the previous generation, install an older version by path. | ||
|
|
||
| ## Install any version by path | ||
|
|
||
| ```sh | ||
| nix-env --profile /nix/var/nix/profiles/site --set <older store path> | ||
| /nix/var/nix/profiles/site/bin/activate | ||
| ``` | ||
|
|
||
| This is the way to roll back past the one kept generation. It is the same as an update with an older path. | ||
|
|
||
| ## `activate` safety | ||
|
|
||
| `activate` must be idempotent, and the previous generation's `activate` must be able to converge the machine back. Safety shall be ensured by comparing snapshots in tests before and after an update and a rollback. | ||
|
|
||
| ## Test | ||
|
|
||
| ```sh | ||
| nix build .#checks.<system>.site -L | ||
| ``` | ||
|
|
||
| The `site` VM test covers loading supautils from the site profile, the `$libdir` fallthrough, and `activate`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| { self, pkgs }: | ||
| let | ||
| system = pkgs.pkgsLinux.stdenv.hostPlatform.system; | ||
| site-env-17 = self.packages.${system}."site-env-17"; | ||
| psql_17 = self.legacyPackages.${system}."psql_17".bin; | ||
| psql_17_slim = self.legacyPackages.${system}."psql_17_slim".bin; | ||
| pgConf = pkgs.writeText "postgresql-test.conf" '' | ||
| dynamic_library_path = '/nix/var/nix/profiles/site/lib/postgresql:$libdir' | ||
| session_preload_libraries = 'supautils' | ||
| unix_socket_directories = '/tmp' | ||
| ''; | ||
| in | ||
| pkgs.testers.runNixOSTest { | ||
| name = "site"; | ||
| nodes.machine = | ||
| { ... }: | ||
| { | ||
| environment.systemPackages = [ site-env-17 ]; | ||
| virtualisation.additionalPaths = [ psql_17 ]; | ||
| users.users.postgres = { | ||
| isSystemUser = true; | ||
| group = "postgres"; | ||
| shell = pkgs.bash; | ||
| }; | ||
| users.groups.postgres = { }; | ||
| }; | ||
| testScript = '' | ||
| # site profile absent: supautils loads from $libdir | ||
| machine.succeed("install -d -o postgres -g postgres /tmp/pgdata-slim") | ||
| machine.succeed("su postgres -c '${psql_17_slim}/bin/initdb -D /tmp/pgdata-slim'") | ||
| machine.succeed("install -o postgres -g postgres ${pgConf} /tmp/pgdata-slim/postgresql.conf") | ||
| machine.succeed("su postgres -c '${psql_17_slim}/bin/pg_ctl -D /tmp/pgdata-slim -l /tmp/pg-slim.log start'") | ||
| machine.succeed("su postgres -c '${psql_17_slim}/bin/psql -h /tmp -d postgres -c \"select 1\"'") | ||
| machine.succeed("su postgres -c '${psql_17_slim}/bin/pg_ctl -D /tmp/pgdata-slim stop'") | ||
|
|
||
| machine.succeed("nix-env --profile /nix/var/nix/profiles/site --set ${site-env-17}") | ||
|
|
||
| # without $libdir in the path, supautils can only come from the site profile | ||
| machine.succeed("install -d -o postgres -g postgres /tmp/pgdata") | ||
| machine.succeed("su postgres -c '${psql_17}/bin/initdb -D /tmp/pgdata'") | ||
| machine.succeed("install -o postgres -g postgres ${pgConf} /tmp/pgdata/postgresql.conf") | ||
| machine.succeed("sed -i 's/:\\$libdir//' /tmp/pgdata/postgresql.conf") | ||
| machine.succeed("grep -qx \"dynamic_library_path = '/nix/var/nix/profiles/site/lib/postgresql'\" /tmp/pgdata/postgresql.conf") | ||
| machine.succeed("su postgres -c '${psql_17}/bin/pg_ctl -D /tmp/pgdata -l /tmp/pg.log start'") | ||
| machine.succeed("su postgres -c '${psql_17}/bin/psql -h /tmp -d postgres -c \"select 1\"'") | ||
| machine.succeed("su postgres -c '${psql_17}/bin/pg_ctl -D /tmp/pgdata stop'") | ||
|
|
||
| machine.succeed("${site-env-17}/bin/activate") | ||
| ''; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This publishes the output paths of the site-env package to public S3 bucket as simple strings in files. It is only used by a scheduled workflow that updates the pins. The pins are the /nix/store path strings themselves so S3 is not part of the update / download.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, so this is why not using a json like the above catalog?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Structured data is not needed here. Plain text is simpler and more robust.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Counterpoint: the structure is stringly typed in the file name.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code to publish and consume it does end up smaller and with fewer failure modes.