README GnuPG

[christoph-maurer]

4 proposals to improve the README section about GnuPG

1. Set GNUPG_SECRET_SIGNING_KEY_FINGERPRINT=placeholder in .env.staging.sample and .env.production.sample to avoid an error message that the fingerprint is missing.

cloud@test01-database:/app/production$ make bootstrap COMMAND='./gpg.mk key PERSON="Christoph Maurer" COMMENT="test01-database" EMAIL="christoph.maurer@fraunhofer.de"'docker compose pull \
        backend
error while interpolating services.backend.environment.XBASE_GnupgSecretSigningKey__Fingerprint: required variable GNUPG_SECRET_SIGNING_KEY_FINGERPRINT is missing a value: required
make: *** [Makefile:177: bootstrap] Error 1

2. The section Generate a GnuPG key needs the forged images from the later section.

3. make bootstrap needs to install make to avoid

cloud@test01-database:/app/staging$ make bootstrap COMMAND='./gpg.mk key PERSON="Christoph Maurer" COMMENT="test01-database" EMAIL="christoph.maurer@frau
nhofer.de"'                                                                                                                                              
docker compose pull \                                                       
        backend                                                             
[+] pull 1/1                                                                
 ✔ Image test01-database_staging-backend:03af9cefea0b5d441275558fab096a64a45a4c08 Skipped                                                            0.0s
docker compose build \                                                                                                                                           --pull \                                                            
        --build-arg GROUP_ID="1000" \                                       
        --build-arg USER_ID="1000" \                                        
        backend                                                             
WARN[0000] No services to build                         
docker compose run \                                                                                                                                     
        --volume .:/app \                                                   
        --rm \                                                              
        backend \                                                                                                                                        
        ./gpg.mk key PERSON="Christoph Maurer" COMMENT="test01-database" EMAIL="christoph.maurer@fraunhofer.de"                                          
[+]  2/2t 2/22                                                              
 ✔ Image postgres:13.23-trixie                          Pulled                                                                                       1.1s
 ✔ Container test01-database_staging_staging-database-1 Running                                                                                      0.0s
Image postgres:13.23-trixie Pulling 
Image postgres:13.23-trixie Pulled 
Container test01-database_staging_staging-backend-run-9fbf348666d9 Creating 
Container test01-database_staging_staging-backend-run-9fbf348666d9 Created 
/usr/bin/env: ‘make’: No such file or directory

make: *** [Makefile:179: bootstrap] Error 127

e.g. with

	docker compose run \
		--volume .:/app \
		--env BOOTSTRAP_COMMAND='${COMMAND}' \
		--rm \
		backend \
		bash -lc 'if ! command -v make >/dev/null 2>&1; then apt-get update && apt-get install --assume-yes --no-install-recommends make; fi; eval "$$BOOTSTRAP_COMMAND"'
.PHONY : bootstrap

4. gpg.mk is missing .env

loud@test01-database:/app/production$ make bootstrap COMMAND='./gpg.mk key PERSON="Christoph Maurer" COMMENT="test01-database" EMAIL="christoph.maurer@f
raunhofer.de"'                                                                                                                                           
docker compose pull \                                                                                                                                    
        backend                                                                                                                                          
[+] pull 1/1                                                                                                                                             
 ✔ Image test01-database_production-backend:03af9cefea0b5d441275558fab096a64a45a4c08 Skipped                                                         0.0s
docker compose build \                                                                                                                                   
        --pull \                                                                                                                                         
        --build-arg GROUP_ID="1000" \                                                                                                                    
        --build-arg USER_ID="1000" \                                                                                                                     
        backend                                                                                                                                          
WARN[0000] No services to build                                                                                                                          
docker compose run \                                                                                                                                     
        --volume .:/app \                                                                                                                                
        --env BOOTSTRAP_COMMAND='./gpg.mk key PERSON="Christoph Maurer" COMMENT="test01-database" EMAIL="christoph.maurer@fraunhofer.de"' \              
        --rm \                                                                                                                                           
        backend \                                                                                                                                        
        bash -lc 'if ! command -v make >/dev/null 2>&1; then apt-get update && apt-get install --assume-yes --no-install-recommends make; fi; eval "$BOOT
STRAP_COMMAND"'                                                                                                                                          
[+]  8/8t 8/88                                                                                                                                           
 ✔ Image postgres:13.23-trixie                                Pulled                                                                                 1.0s
 ✔ Network test01-database_production_production_default      Created                                                                                0.0s
 ✔ Volume test01-database_production_production_files         Created                                                                                0.0s
 ✔ Volume test01-database_production_production_certificates  Created                                                                                0.0s
 ✔ Volume test01-database_production_production_gnupg         Created                                                                                0.0s
 ✔ Volume test01-database_production_production_data          Created                                                                                0.0s
 ✔ Volume test01-database_production_production_backend_logs  Created                                                                                0.0s
 ✔ Container test01-database_production_production-database-1 Started                                                                                0.2s
Image postgres:13.23-trixie Pulling                                                                                                                      
Image postgres:13.23-trixie Pulled                                                                                                                       
Container test01-database_production_production-backend-run-7ecab75495a4 Creating                                                                        
Container test01-database_production_production-backend-run-7ecab75495a4 Created                                                                         
Get:1 http://security.ubuntu.com/ubuntu noble-security InRelease [126 kB]                                                                                
Get:2 https://repos.gnupg.org/deb/gnupg/noble noble InRelease [3745 B]                                                                                   
Get:3 https://repos.gnupg.org/deb/gnupg/noble noble/main amd64 Packages [12.2 kB]                                                                        
Get:4 http://archive.ubuntu.com/ubuntu noble InRelease [256 kB]                             
Get:5 http://security.ubuntu.com/ubuntu noble-security/universe amd64 Packages [1498 kB]
Get:6 http://security.ubuntu.com/ubuntu noble-security/main amd64 Packages [1981 kB]
Get:7 http://security.ubuntu.com/ubuntu noble-security/multiverse amd64 Packages [34.2 kB]
Get:8 http://security.ubuntu.com/ubuntu noble-security/restricted amd64 Packages [3479 kB]
Get:9 http://archive.ubuntu.com/ubuntu noble-updates InRelease [126 kB]                                                                 16:25:27 [80/735]
Get:10 http://archive.ubuntu.com/ubuntu noble-backports InRelease [126 kB]                                                                               
Get:11 http://archive.ubuntu.com/ubuntu noble/multiverse amd64 Packages [331 kB]                                                                         
Get:12 http://archive.ubuntu.com/ubuntu noble/universe amd64 Packages [19.3 MB]                                                                          
Get:13 http://archive.ubuntu.com/ubuntu noble/main amd64 Packages [1808 kB]                                                                              
Get:14 http://archive.ubuntu.com/ubuntu noble/restricted amd64 Packages [117 kB]                                                                         
Get:15 http://archive.ubuntu.com/ubuntu noble-updates/universe amd64 Packages [2142 kB]                                                                  
Get:16 http://archive.ubuntu.com/ubuntu noble-updates/multiverse amd64 Packages [38.0 kB]                                                                
Get:17 http://archive.ubuntu.com/ubuntu noble-updates/main amd64 Packages [2354 kB]                                                                      
Get:18 http://archive.ubuntu.com/ubuntu noble-updates/restricted amd64 Packages [3658 kB]                                                                
Get:19 http://archive.ubuntu.com/ubuntu noble-backports/universe amd64 Packages [35.6 kB]                                                                
Get:20 http://archive.ubuntu.com/ubuntu noble-backports/main amd64 Packages [49.0 kB]                                                                    
Get:21 http://archive.ubuntu.com/ubuntu noble-backports/multiverse amd64 Packages [671 B]                                                                
Fetched 37.5 MB in 4s (9847 kB/s)                                                                                                                        
Reading package lists... Done                                                                                                                            
Reading package lists... Done                                                                                                                            
Building dependency tree... Done                                                                                                                         
Reading state information... Done                                                                                                                        
The following packages were automatically installed and are no longer required:                                                                          
  dirmngr gnupg gnupg-l10n gnupg-utils gnupg2 gpg gpg-agent gpgconf gpgsm libksba8 libreadline8t64 libsqlite3-0 libusb-1.0-0 pinentry-curses             
  readline-common scdaemon                                                                                                                               
Use 'apt autoremove' to remove them.                                                                                                                     
Suggested packages:                                                                                                                                      
  make-doc                                                                                                                                               
The following NEW packages will be installed:                                                                                                            
  make                                                                                                                                                   
0 upgraded, 1 newly installed, 0 to remove and 1 not upgraded.                                                                                           
Need to get 180 kB of archives.                                                                                                                          
After this operation, 414 kB of additional disk space will be used.                                                                                      
Get:1 http://archive.ubuntu.com/ubuntu noble/main amd64 make amd64 4.3-4.1build2 [180 kB]                                                                
Fetched 180 kB in 0s (1111 kB/s)                                                                                                                         
debconf: delaying package configuration, since apt-utils is not installed                                                                                
Selecting previously unselected package make.                                                                                                            
(Reading database ... 6565 files and directories currently installed.)                                                                                   
Preparing to unpack .../make_4.3-4.1build2_amd64.deb ...                                                                                                 
Unpacking make (4.3-4.1build2) ...                                                                                                                       
Setting up make (4.3-4.1build2) ...                                                                                                                      
gpg.mk:4: .env: No such file or directory                                                                                                                
make: *** No rule to make target '.env'.  Stop.                                                                                                          
                                                                                                                                                         
make: *** [Makefile:179: bootstrap] Error 2

[simonwacker]

Oh, interesting issues: .env is not available inside the container anymore because it is a symlink now and with the switch to forging images locally this dependency came about (and using docker compose build ... as was done by bootstrap didn't work anymore in production). All issues should be resolved by 752209a and 9c6e4c5 It's not the cleanest solution because of the case distinctions between development and production.