Merge pull request #87 from samply/release-0.0.5

Release 0.0.5
samply · Apr 15, 2024 · 9689936 · 9689936
2 parents a41d8a8 + 029b3b1
commit 9689936
Show file tree

Hide file tree

Showing 18 changed files with 1,070 additions and 954 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.yml b/.github/ISSUE_TEMPLATE/1-feature-request.yml
@@ -0,0 +1,51 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature]: "
+body:
+  - type: textarea 
+    id: summary
+    attributes:
+      label: General Summary
+      description: Please provide a general summary of the problem
+      placeholder: e.g. "The main issue is that..."
+    validations:
+      required: true
+  - type: textarea
+    id: change 
+    attributes:
+      label: Suggested Change
+      description: Provide details on the suggested change
+      placeholder: e.g. "This new feature will allow users to update..."
+    validations:
+      required: true
+  - type: dropdown
+    id: breaking
+    attributes:
+      label: Is this Breaking?
+      description: Explain the behavior expected in this case
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: true
+  - type: textarea 
+    id: current_behavior
+    attributes:
+      label: Current Behavior
+      description: Explain what the current behavior is
+    validations:
+      required: true
+  - type: textarea
+    id: new_behavior
+    attributes:
+      label: New Behavior
+      description: Propose what the new behavior would be
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Detailed Description
+      description: Please provide a more detailed description
+    validations:
+      required: false 
diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml
@@ -0,0 +1,58 @@
+name: Bug Report
+description: Report a bug to improve Lens
+title: "[Bug]: "
+body:
+  - type: textarea 
+    id: summary
+    attributes:
+      label: General Summary
+      description: Please provide a general summary of the problem
+      placeholder: e.g. "The main issue is that..."
+    validations:
+      required: true
+  - type: textarea 
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: Explain the behavior expected
+      placeholder: e.g. "The feature should do a, then b when you click c."
+    validations:
+      required: true
+  - type: textarea 
+    id: current
+    attributes:
+      label: Current Behavior
+      description: Explain what the actual behavior is
+      placeholder: e.g. "The feature actually does x, y and shows error z."
+    validations:
+      required: true
+  - type: textarea
+    id: possible_solution
+    attributes:
+      label: Possible Solution
+      description: Suggest a possible fix for the bug
+    validations:
+      required: false
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Explain how to reproduce the problem
+      placeholder: e.g. "1. The first step to reproduce this error is to access the members area..."
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Context (Environment)
+      description: Provide context on the setting and environment
+      placeholder: e.g. "This bug happened on a Windows 10 PC running the newest Google Chrome."
+    validations:
+      required: false 
+  - type: textarea
+    id: description
+    attributes:
+      label: Detailed Description
+      description: Please provide a more detailed description
+    validations:
+      required: false 
diff --git a/.github/ISSUE_TEMPLATE/3-vulnerability-report.yml b/.github/ISSUE_TEMPLATE/3-vulnerability-report.yml
@@ -0,0 +1,48 @@
+name: Vulnerability Report
+description: Report a potential software vulnerability
+title: "[Vulnerability]: "
+body:
+  - type: textarea 
+    id: summary
+    attributes:
+      label: General Summary
+      description: Please provide a general summary of the problem
+      placeholder: e.g. "An unsafe deserialization vulnerability allows any unauthenticated user to execute arbitrary code on the server."
+    validations:
+      required: true
+  - type: textarea 
+    id: component
+    attributes:
+      label: Effected Component(s)
+      description: List the components effected by this vulnerability
+    validations:
+      required: true
+  - type: textarea 
+    id: impact 
+    attributes:
+      label: Impact of Vulnerability
+      description: Describe the scope of the vulnerability's impact
+    validations:
+      required: true
+  - type: textarea
+    id: remediation
+    attributes:
+      label: Possible Remediation
+      description: Propose a remediation suggestion if you have one.
+      validations:
+      required: false
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Explain how to reproduce the problem
+      placeholder: e.g. "1. The first step to reproduce this error is to access the members area..."
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Detailed Description
+      description: Please provide a more detailed description
+    validations:
+      required: false 
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,24 @@
+### General Summary
+
+### Description
+<!--- Describe changes in detail -->
+
+### Related Issue
+<!--- Please link to the issue here: -->
+
+---
+
+### Motivation and Context
+
+### How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+
+### Screenshots (if appropriate):
+
+---
+
+<!--- Please check if the PR fulfills these requirements -->
+- [ ] The commit message follows guidelines
+- [ ] Tests for the changes have been added
+- [ ] Documentation has been added/ updated
diff --git a/.github/workflows/docker-develop.yml b/.github/workflows/docker-develop.yml
@@ -24,6 +24,7 @@ jobs:
       build-args: |
         TARGET_ENVIRONMENT=staging
       build-platforms: "linux/amd64"
+      push-to: dockerhub
     # This passes the secrets from calling workflow to the called workflow
     secrets:
       DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -30,6 +30,7 @@ jobs:
       build-args: |
         TARGET_ENVIRONMENT=production
       build-platforms: "linux/amd64"
+      push-to: dockerhub
     # This passes the secrets from calling workflow to the called workflow
     secrets:
       DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -23,9 +23,9 @@ services:
     ports:
       - 8080:8080
     environment:
-      BEAM_SECRET: "${LOCAL_BEAM_SECRET}"
+      BEAM_SECRET: "${LOCAL_BEAM_SECRET_SPOT}"
       BEAM_PROXY_URL: http://beam-proxy:8081
-      BEAM_APP_ID: "focus.${LOCAL_BEAM_ID}.${BROKER_HOST}"
+      BEAM_APP_ID: "spot.${LOCAL_BEAM_ID}.${BROKER_HOST}"
     depends_on:
       - "beam-proxy"
     profiles:
@@ -36,7 +36,7 @@ services:
     environment:
       BROKER_URL: https://${BROKER_HOST}
       PROXY_ID: ${LOCAL_BEAM_ID}.${BROKER_HOST}
-      APP_focus_KEY: ${LOCAL_BEAM_SECRET}
+      APP_spot_KEY: ${LOCAL_BEAM_SECRET_SPOT}
       PRIVKEY_FILE: /run/secrets/proxy.pem
       ALL_PROXY: ${http_proxy}
     secrets:

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -59,15 +59,21 @@ services:
   spot:
     image: samply/rustyspot:main
     environment:
-      BEAM_SECRET: "${LOCAL_BEAM_SECRET}"
+      HTTP_PROXY: ${http_proxy}
+      HTTPS_PROXY: ${https_proxy}
+      NO_PROXY: beam-proxy, prism
+      BEAM_SECRET: "${LOCAL_BEAM_SECRET_SPOT}"
       BEAM_PROXY_URL: http://beam-proxy:8081
-      BEAM_APP_ID: "focus.${LOCAL_BEAM_ID}.${BROKER_HOST}"
+      BEAM_APP_ID: "spot.${LOCAL_BEAM_ID}.${BROKER_HOST}"
       CORS_ORIGIN: "https://${GUI_HOST}"
+      CATALOGUE_URL: "${CATALOGUE_URL}"
+      BIND_ADDR: 0.0.0.0:8055
+      PRISM_URL: http://prism:8066
     depends_on:
       - "beam-proxy"
     labels:
       - "traefik.enable=true"
-      - "traefik.http.services.spot.loadbalancer.server.port=8080"
+      - "traefik.http.services.spot.loadbalancer.server.port=8055"
       - "traefik.http.middlewares.corsheaders.headers.accesscontrolallowmethods=GET,OPTIONS,POST"
       - "traefik.http.middlewares.corsheaders.headers.accesscontrolallowheaders=content-type"
       - "traefik.http.middlewares.corsheaders.headers.accesscontrolalloworiginlist=https://${GUI_HOST}"
@@ -83,13 +89,36 @@ services:
     environment:
       BROKER_URL: https://${BROKER_HOST}
       PROXY_ID: ${LOCAL_BEAM_ID}.${BROKER_HOST}
-      APP_focus_KEY: ${LOCAL_BEAM_SECRET}
+      APP_spot_KEY: ${LOCAL_BEAM_SECRET_SPOT}
+      APP_prism_KEY: ${LOCAL_BEAM_SECRET_PRISM}
       PRIVKEY_FILE: /run/secrets/proxy.pem
       ALL_PROXY: ${http_proxy}
     secrets:
       - proxy.pem
       - root.crt.pem
 
+  prism:
+    image: samply/prism:main
+    environment:
+      # TODO: Autogenerate this
+      API_KEY: "${LOCAL_BEAM_SECRET_PRISM}"
+      BEAM_PROXY_URL: http://beam-proxy:8081
+      BEAM_APP_ID_LONG: prism.${LOCAL_BEAM_ID}.${BROKER_HOST}
+      CORS_ORIGIN: "https://${GUI_HOST}"
+      SITES: ${SITES}
+      PROJECT: ${PROJECT}
+      BIND_ADDR: 0.0.0.0:8066
+      RUST_LOG: "debug,hyper=info"
+    depends_on:
+      - "beam-proxy"
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.services.prism.loadbalancer.server.port=8066"
+      - "traefik.http.routers.prism.rule=Host(`${GUI_HOST}`) && PathPrefix(`/prism`)"
+      - "traefik.http.routers.prism.tls=true"
+      - "traefik.http.middlewares.prism-stripprefix.stripprefix.prefixes=/prism"
+      - "traefik.http.routers.prism.middlewares=corsheaders,traefik-forward-auth,prism-stripprefix"
+
 secrets:
   proxy.pem:
     # TODO: Key in BBMRI was directly stored in lens directory!

diff --git a/docs/GIT_FLOW.md b/docs/GIT_FLOW.md
@@ -42,104 +42,3 @@ Please see **[Semantic Versioning](https://semver.org/)**
 **SemVer** -> fix type commits should be translated to PATCH releases. feat type commits should be translated to MINOR releases. Commits with BREAKING CHANGE in the commits, regardless of type, should be translated to MAJOR releases.
 
 See more: [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification)
-
-## Issues Templates:
-
-### Bug report
-
-```
-## General Summary
-
-## Expected Behavior
-
-## Current Behavior
-
-## Possible Solution
-<!--- Suggest a fix/reason for the bug (optional) -->
-
-## Steps to Reproduce
-<!--- Provide a link to a live example if possible -->
-1.
-2.
-3.
-4.
-
-## Context (Environment)
-
-## Detailed Description
-
-## Possible Implementation
-```
-
-### Feature request
-
-```
-## Suggested Change
-<!--- What kind of change does this PR introduce? -->
-
-## Is This Breaking?
-<!--- Does this PR introduce a breaking change? -->
-
-## Current Behavior
-
-## New Behavior
-
-## Detailed Description
-
-```
-
-### Vulnerability report
-
-```
-# Vulnerability Report
-
-I identified potential security vulnerabilities in [Component].
-
-## Summary
-<!--- Short summary: E.g. An unsafe deserialization vulnerability allows any unauthenticated user to execute arbitrary code on the server. -->
-
-## Component
-
-## Impact
-
-## Remediation
-<!--- Propose a remediation suggestion if you have one. Make it clear that this is just a suggestion, as the maintainer might have a better idea to fix the issue. -->
-
-## Steps to Reproduce
-<!--- Provide a link to a live example if possible -->
-1.
-2.
-3.
-4.
-
-## Detailed Description
-<!--- Give all details on the vulnerability; especially the code -->
-
-```
-
-## PR Template
-```
-<!--- Please check if the PR fulfills these requirements -->
-- [ ] The commit message follows guidelines
-- [ ] Tests for the changes have been added
-- [ ] Documentation has been added/ updated
-
-## General Summary
-
-## Description
-<!--- Describe changes in detail -->
-
-## Related Issue
-<!--- Please link to the issue here: -->
-
-## Motivation and Context
-
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-
-## Screenshots (if appropriate):
-```
-
-For reference: *[Using templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)*
-