Initial commit

Author: robin-rpr

.github/workflows/main.yml

@@ -0,0 +1,43 @@
+name: Main
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          install: true
+
+      - name: Create Docker Buildx builder
+        run: docker buildx create --use --name mybuilder
+
+      - name: Build and push image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/postgres:latest
+            ${{ secrets.DOCKERHUB_USERNAME }}/postgres:${{ env.VERSION }}
+          platforms: linux/amd64

Dockerfile

@@ -11,15 +11,13 @@ ENV PGDATA_TS=/var/lib/postgresql/ts/data
 VOLUME ["/var/lib/postgresql/data"]
 VOLUME ["/var/lib/postgresql/ts"]
 
-ADD --chmod=755 scripts/004_obmp_psql_cfg.sh /docker-entrypoint-initdb.d/004_obmp_psql_cfg.sh
-ADD --chmod=755 scripts/005_obmp_init.sh /docker-entrypoint-initdb.d/005_obmp_init.sh
+ADD --chmod=755 scripts/001_configuration.sh /docker-entrypoint-initdb.d/001_configuration.sh
+ADD --chmod=755 scripts/002_initialization.sh /docker-entrypoint-initdb.d/002_initialization.sh
 
 USER root
 
 RUN  rm -rf /usr/lib/postgresql/12 /usr/lib/postgresql/13  \
      && mkdir -p /var/lib/postgresql/data /var/lib/postgresql/ts/data \
      && chown -R postgres /var/lib/postgresql/data /var/lib/postgresql/ts/data \
-     && mkdir -p /usr/local/openbmp \
-     && touch /usr/local/openbmp/version-${VERSION}
 
 USER postgres

README.md

@@ -1,26 +1,20 @@
-# OpenBMP Postgres
+# Postgres
 The postgres container is a plain postgres/timescaleDB container with
-some modifications to support OpenBMP.  Any postgres install will work as long as
-they have similar changes as shown in [Dockerfile](Dockerfile).  
+some modifications to support our application.
 
 ## Building
 See the [Dockerfile](Dockerfile) notes for build instructions. 
 
-## Running
+## Getting Started
 ```
 docker run --rm -it -p 5432:5432 \
-    -e POSTGRES_PASSWORD=openbmp \
-    -e POSTGRES_USER=openbmp \
-    -e POSTGRES_DB=openbmp \
-    openbmp/postgres:<version>
+    -e POSTGRES_PASSWORD=bgpdata \
+    -e POSTGRES_USER=bgpdata \
+    -e POSTGRES_DB=bgpdata \
+    bgpdata/postgres:<version>
 ```
 
-### Configuration/Environment Variables
-See both [Postgres](https://hub.docker.com/_/postgres) and
-[TimescaleDB](https://hub.docker.com/r/timescale/timescaledb) documentation for more
-information on how to configure/run the docker container. 
-
-### PostgreSQL Related
+### Additional Information
 
 #### Postgres can be killed by the Linux OOM-Killer
 This is very bad as it causes Postgres to restart. This will happen because postgres uses a large shared buffer,
@@ -52,38 +46,36 @@ then try the below:
     echo never > /sys/kernel/mm/transparent_hugepage/defrag
     sync && echo 3 > /proc/sys/vm/drop_caches
 
-
-#### Postgres Vacuum (reclaim disk space)
+#### Postgres Vacuum (Reclaim Disk Space)
 Postgres reclaims deleted/updated records using the vacuum process.  You can run this manually/cron via the
 ```VACUUM``` command.  **autovacuum** is used to do this periodically.   Careful tuning of this
 is required.  Checkout [autovacuum-tuning-basics](https://blog.2ndquadrant.com/autovacuum-tuning-basics/),
 [Routine Vacuuming](https://www.postgresql.org/docs/current/static/routine-vacuuming.html), and
 [VACUUM](https://www.postgresql.org/docs/current/static/sql-vacuum.html) for more details. 
 
-#### Create persistent postgres locations
+#### Persistent Postgres locations
 
 *You should use fast SSD and/or ZFS.*  Size of these locations/mount points are directly related to the
 number of NLRI's maintained and number of changes/updates per second.
 
-> TODO: Will post numbers of how to determine the disk size needed.  For now, if you have less
-> than 50,000,00 prefixes, then you can use 1TB.  If you have more than that, you should consider
-> multiple disks.  ZFS can make your life easier as you can easily add disks and it supports compression.
+> NOTE: If you have less than 50,000,00 prefixes, then you can use 1TB. If you have more than that, please consider
+> multiple disks. ZFS can make our life easier as you can easily add disks and it supports compression.
 
 - **postgres/main** - This location will be used for the main postgres data
   files and tables.
 
 > This really should be a mount point to a dedicated filesystem
 
 ```
-    mkdir -p /var/openbmp/postgres/main
-    chmod 7777 /var/openbmp/postgres/main
+    mkdir -p /var/bgpdata/postgres/main
+    chmod 7777 /var/bgpdata/postgres/main
 ```
 
 - **postgres/ts** - This location will be used for the time series postgres tables
 
 > This really should be a mount point to a dedicated filesystem
 
 ```
-    mkdir -p /var/openbmp/postgres/ts
-    chmod 7777 /var/openbmp/postgres/ts
+    mkdir -p /var/bgpdata/postgres/ts
+    chmod 7777 /var/bgpdata/postgres/ts
 ```

scripts/004_obmp_psql_cfg.sh scripts/001_configuration.shscripts/004_obmp_psql_cfg.sh renamed to scripts/001_configuration.sh

@@ -1,10 +1,6 @@
 #!/bin/bash
-
-# OpenBMP Postgres configuration
-#
-#  Copyright (c) 2022 Cisco Systems, Inc. and Tim Evens.  All rights reserved.
-#
-
+# Copyright (c) 2021-2022 Cisco Systems, Inc. and others.
+# All rights reserved.
 
 # Create SSL cert
 openssl req -x509 -newkey rsa:4096 -nodes -subj "/C=US/ST=CA/L=Seattle/O=OpenBMP/CN=localhost"  \
@@ -23,12 +19,11 @@ sed -i -e "s/^\#*ssl_key_file.*=.*/ssl_key_file =  '${PGDATA//\//\\\/}\/psql_ser
 
 sed -i -e "s/^shared_preload_libraries.*/shared_preload_libraries = 'timescaledb,pg_cron'/g" $PGDATA/postgresql.conf
 
-echo "cron.database_name = 'openbmp'" >> $PGDATA/postgresql.conf
+echo "cron.database_name = '$POSTGRES_DB'" >> $PGDATA/postgresql.conf
 
 egrep -q -e '^hostssl( |\t)+all' $PGDATA/pg_hba.conf
 if [[ $? ]]; then
     echo 'hostssl    all        all        0.0.0.0/0        md5' >> $PGDATA/pg_hba.conf
 fi
 
-
 pg_ctl -D "$PGDATA" -m fast -w restart

scripts/005_obmp_init.sh scripts/002_initialization.shscripts/005_obmp_init.sh renamed to scripts/002_initialization.sh

@@ -1,11 +1,8 @@
 #!/bin/bash
+# Copyright (c) 2021-2022 Cisco Systems, Inc. and others.
+# All rights reserved.
 
-# postgres: Init script
-#
-#  Copyright (c) 2021-2022 Cisco Systems, Inc. and Tim Evens.  All rights reserved.
-#
-
-# >> NOTE, before adding extensions, required preload/config should be done first in 004_obmp_psql_cfg.sh
+# Required: Execute 004_obmp_psql_cfg.sh for preload configuration before adding extensions
 
 # Add extensions
 psql -U $POSTGRES_USER -c "CREATE EXTENSION IF NOT EXISTS postgis CASCADE;" $POSTGRES_DB