Skip to content

docs: add documentation for #1024 #1027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 18, 2023
Merged

docs: add documentation for #1024 #1027

merged 1 commit into from
Dec 18, 2023

Conversation

iccicci
Copy link
Collaborator

@iccicci iccicci commented Dec 15, 2023

Context

I merged #1024 too much fast

Proposed Solution

Added references to the possible issues introduced

mirceahasegan
mirceahasegan approved these changes Dec 15, 2023
View reviewed changes
Copy link
Contributor

@mirceahasegan mirceahasegan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! 🥇

@github-actions GitHub Actions
Copy link

Standard DiffPost

This PR would generate the following kubectl diff:

Preview 
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-backend /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-backend
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:16.182795049 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:16.182795049 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "92"
   creationTimestamp: "2023-08-11T18:16:12Z"
-  generation: 92
+  generation: 93
   labels:
     app: backend
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-backend
@@ -89,7 +89,7 @@
           value: "false"
         - name: USE_KORA_LABS
           value: "true"
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-coingecko-proxy /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-coingecko-proxy
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:16.494800575 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:16.494800575 +0000
@@ -8,7 +8,7 @@
   labels:
     app: coingecko-proxy
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-coingecko-proxy
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-projector /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-projector
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-projector	2023-12-18 11:13:16.822806385 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-projector	2023-12-18 11:13:16.822806385 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "92"
   creationTimestamp: "2023-08-11T18:16:13Z"
-  generation: 92
+  generation: 93
   labels:
     app: handle-projector
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-handle-projector
@@ -73,7 +73,7 @@
               name: handle-owner-user.dev-preview-dbsync-db.credentials.postgresql.acid.zalan.do
         - name: PROJECTION_NAMES
           value: handle
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-provider /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-provider
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-provider	2023-12-18 11:13:17.138811978 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-handle-provider	2023-12-18 11:13:17.138811978 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "59"
   creationTimestamp: "2023-08-11T18:16:13Z"
-  generation: 59
+  generation: 60
   labels:
     app: handle-provider
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-handle-provider
@@ -81,7 +81,7 @@
           value: handle
         - name: USE_KORA_LABS
           value: "true"
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-pg-boss-worker /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-pg-boss-worker
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-pg-boss-worker	2023-12-18 11:13:17.454817579 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-pg-boss-worker	2023-12-18 11:13:17.454817579 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "92"
   creationTimestamp: "2023-08-11T18:16:13Z"
-  generation: 92
+  generation: 93
   labels:
     app: pg-boss-worker
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-pg-boss-worker
@@ -95,7 +95,7 @@
           value: pool-delist-schedule,pool-metadata,pool-metrics,pool-rewards
         - name: STAKE_POOL_PROVIDER_URL
           value: http://dev-preview-cardanojs-backend.dev-preview.svc.cluster.local
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-projector /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-projector
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-projector	2023-12-18 11:13:17.766823103 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-projector	2023-12-18 11:13:17.766823103 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "92"
   creationTimestamp: "2023-08-11T18:16:13Z"
-  generation: 92
+  generation: 93
   labels:
     app: stake-pool-projector
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-stake-pool-projector
@@ -73,7 +73,7 @@
               name: stakepool-owner-user.dev-preview-dbsync-db.credentials.postgresql.acid.zalan.do
         - name: PROJECTION_NAMES
           value: stake-pool,stake-pool-metadata-job,stake-pool-metrics-job,stake-pool-rewards-job
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-provider /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-provider
--- /tmp/LIVE-2638198659/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-provider	2023-12-18 11:13:18.082828704 +0000
+++ /tmp/MERGED-259436010/apps.v1.Deployment.dev-preview.dev-preview-cardanojs-stake-pool-provider	2023-12-18 11:13:18.082828704 +0000
@@ -4,11 +4,11 @@
   annotations:
     deployment.kubernetes.io/revision: "89"
   creationTimestamp: "2023-08-11T18:16:13Z"
-  generation: 89
+  generation: 90
   labels:
     app: stake-pool-provider
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-stake-pool-provider
@@ -83,7 +83,7 @@
           value: http://dev-preview-cardano-stack-metadata.dev-preview.svc.cluster.local
         - name: USE_TYPEORM_STAKE_POOL_PROVIDER
           value: "true"
-        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:c557hndmqibv3622ch5ivmg25i07rs3b
+        image: 926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services:iq8zhk4z1gg1sqcagr0maiq9s8apflmh
         imagePullPolicy: IfNotPresent
         livenessProbe:
           failureThreshold: 3
diff -u -N /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-backend-monitor /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-backend-monitor
--- /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-backend-monitor	2023-12-18 11:13:18.394834228 +0000
+++ /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-backend-monitor	2023-12-18 11:13:18.394834228 +0000
@@ -5,7 +5,7 @@
   generation: 2
   labels:
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     instance: primary
   name: lace-backend-monitor
   namespace: dev-preview
diff -u -N /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-handle-provider-monitor /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-handle-provider-monitor
--- /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-handle-provider-monitor	2023-12-18 11:13:18.718839966 +0000
+++ /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-handle-provider-monitor	2023-12-18 11:13:18.718839966 +0000
@@ -5,7 +5,7 @@
   generation: 2
   labels:
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     instance: primary
   name: lace-handle-provider-monitor
   namespace: dev-preview
diff -u -N /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-stake-pool-provider-monitor /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-stake-pool-provider-monitor
--- /tmp/LIVE-2638198659/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-stake-pool-provider-monitor	2023-12-18 11:13:19.030845494 +0000
+++ /tmp/MERGED-259436010/monitoring.coreos.com.v1.ServiceMonitor.dev-preview.lace-stake-pool-provider-monitor	2023-12-18 11:13:19.030845494 +0000
@@ -5,7 +5,7 @@
   generation: 2
   labels:
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     instance: primary
   name: lace-stake-pool-provider-monitor
   namespace: dev-preview
diff -u -N /tmp/LIVE-2638198659/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-backend /tmp/MERGED-259436010/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-backend
--- /tmp/LIVE-2638198659/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:19.350851163 +0000
+++ /tmp/MERGED-259436010/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:19.350851163 +0000
@@ -19,7 +19,7 @@
   labels:
     app: backend
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-backend
diff -u -N /tmp/LIVE-2638198659/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-coingecko-proxy /tmp/MERGED-259436010/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-coingecko-proxy
--- /tmp/LIVE-2638198659/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:19.666857310 +0000
+++ /tmp/MERGED-259436010/networking.k8s.io.v1.Ingress.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:19.666857310 +0000
@@ -16,7 +16,7 @@
   labels:
     app: coingecko-proxy
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-coingecko-proxy
diff -u -N /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-backend /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-backend
--- /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:14.942773087 +0000
+++ /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-backend	2023-12-18 11:13:14.942773087 +0000
@@ -5,7 +5,7 @@
   labels:
     app: backend
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-backend
diff -u -N /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-coingecko-proxy /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-coingecko-proxy
--- /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:15.250778541 +0000
+++ /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-coingecko-proxy	2023-12-18 11:13:15.250778541 +0000
@@ -5,7 +5,7 @@
   labels:
     app: coingecko-proxy
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-coingecko-proxy
diff -u -N /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-handle-provider /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-handle-provider
--- /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-handle-provider	2023-12-18 11:13:15.562784067 +0000
+++ /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-handle-provider	2023-12-18 11:13:15.562784067 +0000
@@ -5,7 +5,7 @@
   labels:
     app: handle-provider
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-handle-provider
diff -u -N /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-stake-pool-provider /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-stake-pool-provider
--- /tmp/LIVE-2638198659/v1.Service.dev-preview.dev-preview-cardanojs-stake-pool-provider	2023-12-18 11:13:15.870789522 +0000
+++ /tmp/MERGED-259436010/v1.Service.dev-preview.dev-preview-cardanojs-stake-pool-provider	2023-12-18 11:13:15.870789522 +0000
@@ -5,7 +5,7 @@
   labels:
     app: stake-pool-provider
     app.kubernetes.io/managed-by: std-kubectl
-    app.kubernetes.io/version: bafa161582eb18e865d37b9f268d67ce66309b9c
+    app.kubernetes.io/version: f65035717effece7ac3172c00c3dfd85b351197e
     network: preview
     release: dev-preview-cardanojs
   name: dev-preview-cardanojs-stake-pool-provider

@iccicci iccicci merged commit 71bce07 into master Dec 18, 2023
@iccicci iccicci deleted the chore/improve-docs branch December 18, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkazlauskas mkazlauskas mkazlauskas approved these changes

@mirceahasegan mirceahasegan mirceahasegan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@iccicci @mkazlauskas @mirceahasegan