Merge pull request #25 from mmohamed/feat/api

Feat API

Author: mmohamed

.env.dist

@@ -8,6 +8,8 @@ USE_FSBACKUP=1
 DEBUG=1
 READ_ONLY_USER=0
 AUDIT_LOG=1
+API_PORT=3002
+API_SUB_PATH=/api
 METRICS=true
 METRICS_PORT=3001
 METRICS_PATH=metrics

CHANGELOG.md

@@ -34,3 +34,9 @@ All notable changes to this project will be documented in this file.
 ### Changed
 
 - Upgrade dependencies: @kubernetes/client-node from 0.19.0 to 0.20.0
+
+## [1.2.0] - 2024-01-10
+
+### Added
+
+- Full Rest API support V1 (swagger doc)

README.md

@@ -22,6 +22,7 @@ This is a very simplified Velero dashboard for backup, restore and schedule mana
 - Delete a schedule
 - Pause / Unpause a schedule
 - Get backup and restore result information (logs included)
+- Full Rest API support (docs /v1/docs)
 
 ### 2. App features
 
@@ -43,7 +44,7 @@ LDAP_SEARCH_BASE="OU=users,DC=mtr,DC=com"
 LDAP_SEARCH_FILTER=sAMAccountName
 ```
 
-- Multi-tenant & User access namspaced scope : With LDAP configuration, you can define a scope control based on an assotioation of a LDAP groups and a list of namespace, for example, if a user X is member of LDAP group group-it, he can manage backup, restore and schedule with include-namespace associated to the group-it (all namespace mut be accessible by the user to see these resources)
+- Multi-tenant & User access namespaced scope : With LDAP configuration, you can define a scope control based on an assotioation of a LDAP groups and a list of namespace, for example, if a user X is member of LDAP group group-it, he can manage backup, restore and schedule with include-namespace associated to the group-it (all namespace mut be accessible by the user to see these resources)
 
 ```ini
 NAMESPACE_FILTERING='[{"group": "group-it", "namespaces": ["ns1","ns2","ns3"]}]' # json list
@@ -86,11 +87,13 @@ MULTI_CLUSTER_CONFIG_DIR=/absolut/path/config/dir #default false
 
 _Important : If metrics is enabled, a cluster label will contain the context name of the metric._
 
-- Web app options : to define Web app listening port , a secret key for session encryption, a subpath (baypass absolute UI URL), a secured cookie restriction (work only with SSL on backned enabled, key and cert files required) and the admin credentials
+- Web app options : to define Web app listening port , api server listening port and subpath, a secret key for session encryption, a subpath (baypass absolute UI URL), a secured cookie restriction (work only with SSL on backned enabled, key and cert files required) and the admin credentials
 
 ```ini
 SECRET_KEY=random-secret-key #default default-secret-mut-be-changed
 APP_PORT=8080 #default 3000
+API_PORT=8082 #default 3002
+API_SUB_PATH=/api #default /
 SECURE_HOST=true # default false
 SECURE_HOST_CERT_FILE_PATH=/absolut/path/to/cert/file # default false
 SECURE_HOST_KEY_FILE_PATH=/absolut/path/to/key/file # default false

app.js

@@ -1,10 +1,15 @@
 const server = require('./src/main');
 const tools = require('./src/tools');
+const api = require('./src/api');
 
 server.app.listen(tools.port(), () => {
   console.log(new Date(), ': Application started...');
 });
 
+api.listen(tools.apiPort(), () => {
+  console.log(new Date(), ': API server started...');
+});
+
 if (tools.metrics()) {
   server.metrics.listen(tools.metricsPort(), () => {
     console.log(new Date(), ': Metrics server started...');

app.test.js

@@ -12,15 +12,24 @@ express.mockReturnValue({
   },
   get: function () {},
   post: function () {},
-  delete: function () {}
+  delete: function () {},
+  put: function () {}
+});
+
+express.Router.mockReturnValue({
+  get: function () {},
+  post: function () {},
+  delete: function () {},
+  put: function () {},
+  use: function () {}
 });
 
 process.env.METRICS = true;
 const server = require('./app.js');
 
 describe('Check lanching servers', () => {
-  it('should app/metrics server in running mode', async () => {
-    expect(ports.length).toEqual(2);
-    expect(ports).toEqual([3000, 3001]);
+  it('should app/metrics/api servers in running mode', async () => {
+    expect(ports.length).toEqual(3);
+    expect(ports).toEqual([3000, 3002, 3001]);
   });
 });

kubernetes/my-velero.yaml

@@ -66,6 +66,8 @@ spec:
               protocol: TCP
             - containerPort: 3001
               protocol: TCP
+            - containerPort: 3002
+              protocol: TCP
           resources:
             limits:
               cpu: 1000m
@@ -95,11 +97,13 @@ spec:
             # - name: SECURE_HOST_CERT_FILE_PATH
             #   value: "/usr/src/tls/tls.crt"
             # - name: SECURE_HOST_KEY_FILE_PATH
-            #   value: "/usr/src/tls/tls.key"   
+            #   value: "/usr/src/tls/tls.key"
             - name: DEBUG
               value: '1'
             - name: METRICS
               value: '1'
+            - name: API_SUB_PATH
+              value: '/api'
             - name: LDAP_HOST
               value: ldaps://my-velero-ldap-svc.velero.svc.cluster.local:636
             - name: LDAP_SKIP_SSL
@@ -115,7 +119,7 @@ spec:
             - name: LDAP_SEARCH_FILTER
               value: sAMAccountName
             - name: NAMESPACE_FILTERING
-              value: '[{"group": "IT", "namespaces": ["ovpn","ovpn-dev","ovpn-prd"]}]'
+              value: '[{"group": "IT", "namespaces": ["qrcode","qrcode-dev","qrcode-prd"]}]'
 
 ---
 apiVersion: v1
@@ -128,6 +132,9 @@ spec:
     - name: http
       port: 80
       targetPort: 3000
+    - name: api
+      port: 81
+      targetPort: 3002
   selector:
     app: myvelero
 
@@ -152,6 +159,10 @@ spec:
               serviceName: my-velero-svc
               servicePort: http
             path: /
+          - backend:
+              serviceName: my-velero-svc
+              servicePort: api
+            path: /api
   tls:
     - hosts:
         - myvelero.medinvention.dev