Replace journal-id to journal-fqdn

Author: ad-m

README.md

@@ -14,22 +14,22 @@ This Docker plugin extends and expands Docker's logging capabilities so that cus
 1. Download plugin
 
 ```bash
-$ docker plugin install h1cr.io/h1-docker-logging-plugin
+docker plugin install h1cr.io/h1-docker-logging-plugin
 ```
 
 2. Enable plugin
 
 ```bash
-$ docker plugin enable h1cr.io/h1-docker-logging-plugin
+docker plugin enable h1cr.io/h1-docker-logging-plugin
 ```
 
 ## Install Docker logging plugin from source
 
 1. Clone the repository and check out release branch:
 
 ```bash
-$ cd h1-docker-journal-plugin
-$ git checkout release
+cd h1-docker-journal-plugin
+git checkout release
 ```
 
 2. Build the plugin:
@@ -50,10 +50,10 @@ Configure the plugin separately for each container when using the docker run com
 
 ```bash
 docker run --rm --label x \
-	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
-	--log-opt journal-id=5d4362e4939bdbe421cb09ee \
-	--log-opt journal-token=test \
-	-it alpine id
+    --log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
+    --log-opt journal-fqdn=5d78e1427fd7e0228fe18f46.journal.pl-waw-1.hyperone.cloud \
+    --log-opt journal-token=test \
+    -it alpine id
 ```
 
 Now that the plugin is installed and configured, it will send logs while the container is running.
@@ -62,8 +62,8 @@ Now that the plugin is installed and configured, it will send logs while the con
 
 | Name | Description |
 | -----| ------------
-| ```journal-id``` | Journal ID that will receive logs
-| ```journal-token``` | Credential (password) to journal indicated in the parameter ```journal-id```
+| ```journal-fqdn``` | Journal FQDN that will receive logs
+| ```journal-token``` | Credential (password) to journal indicated in the parameter ```journal-fqdn```
 
 ### Optional variables
 

driver.js

@@ -37,7 +37,7 @@ module.exports = () => {
     const driver = {};
 
     driver.startLogging = async (stream, File, Info) => {
-        ['journal-id', 'journal-token'].forEach(name => {
+        ['journal-fqdn', 'journal-token'].forEach(name => {
             if (!Info.Config[name]) {
                 throw new Error(`Missing '${name} option of log driver`);
             }

journal.js

@@ -4,7 +4,7 @@ const logger = require('superagent-logger');
 const WebSocket = require('ws');
 
 module.exports = (config) => {
-    const url = `http://${config['journal-id']}.journal.pl-waw-1.hyperone.cloud/log`;
+    const url = `http://${config['journal-fqdn']}/log`;
     const agent = require('superagent').agent().use(logger);
     return {
         checkJournalToken: () => agent.head(url).query({ follow: false })
@@ -35,13 +35,13 @@ module.exports = (config) => {
             });
 
             ws.on('open', () => {
-                console.log(config['journal-id'], 'websocket opened');
+                console.log(config['journal-fqdn'], 'websocket opened');
                 const stream = WebSocket.createWebSocketStream(ws);
                 resolve(stream);
             });
 
             ws.on('close', () => {
-                console.log(config['journal-id'], 'websocket closed');
+                console.log(config['journal-fqdn'], 'websocket closed');
             });
             ws.on('error', reject);
         }),

tests/driver.js

@@ -40,7 +40,7 @@ class LogGenerator extends Readable {
 
 const defaultInfo = {
     Config: {
-        'journal-id': process.env.JOURNAL_ID,
+        'journal-fqdn': `${process.env.JOURNAL_ID}.journal.pl-waw-1.hyperone.cloud`,
         'journal-token': process.env.JOURNAL_TOKEN,
     },
     ContainerID: 'eddeb66fc259',

tests/e2e/e2e.bats

@@ -17,7 +17,7 @@ teardown() {
     run docker run \
 	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
     --label dockerbats="$BATS_TEST_NAME" \
-	--log-opt journal-id=${JOURNAL_ID} \
+	--log-opt journal-fqdn=${JOURNAL_ID}.journal.pl-waw-1.hyperone.cloud \
 	--log-opt journal-token=${JOURNAL_TOKEN} \
 	alpine sh -c 'echo $RANDOM';
     [ "$status" -eq 0 ];
@@ -31,7 +31,7 @@ teardown() {
     run docker run -d \
 	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
     --label dockerbats="$BATS_TEST_NAME" \
-	--log-opt journal-id=${JOURNAL_ID} \
+	--log-opt journal-fqdn=${JOURNAL_ID}.journal.pl-waw-1.hyperone.cloud \
 	--log-opt journal-token=${JOURNAL_TOKEN} \
 	alpine sh -c 'seq 1 10; sleep 30';
     [ "$status" -eq 0 ];
@@ -48,7 +48,7 @@ teardown() {
     run docker run \
 	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
     --label dockerbats="$BATS_TEST_NAME" \
-	--log-opt journal-id=${JOURNAL_ID} \
+	--log-opt journal-fqdn=${JOURNAL_ID}.journal.pl-waw-1.hyperone.cloud \
 	--log-opt journal-token=${JOURNAL_TOKEN} \
 	alpine sh -c "seq 100 | while read line; do echo \"multiple-\${line}-${token}\"; done;";
     [ "$status" -eq 0 ]
@@ -64,15 +64,15 @@ teardown() {
 	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
     --label dockerbats="$BATS_TEST_NAME" \
 	alpine id;
-    [[ $output =~ "Missing 'journal-id option of log driver." ]]
+    [[ $output =~ "Missing 'journal-fqdn option of log driver." ]]
     [ "$status" -eq 125 ]
 }
 
 @test "plugin validate token" {
     run docker run -d \
 	--log-driver 'h1cr.io/h1-docker-logging-plugin:latest' \
     --label dockerbats="$BATS_TEST_NAME" \
-	--log-opt journal-id="${JOURNAL_ID}" \
+	--log-opt journal-fqdn=${JOURNAL_ID}.journal.pl-waw-1.hyperone.cloud \
 	--log-opt journal-token="invalid token" \
 	alpine id;
     [[ $output =~ "Invalid journal-token." ]]