Merge pull request #101 from George-Wu/config

Update config for marketplace click-to-deploy solution

marketplace_confg/chart/dicom-adapter/Chart.yaml

@@ -1,3 +1,3 @@
 name: dicom-adapter-mp
-version: "0.2.1"
+version: "0.2.14"
 apiVersion: v1

marketplace_confg/chart/dicom-adapter/templates/application.yaml

@@ -18,8 +18,8 @@ spec:
       kind: StatefulSet
   addOwnerRef: true
   descriptor:
-    type: "dicom adapter"
-    version: "0.2.1"
+    type: dicom adapter
+    version: "0.2.14"
     keywords:
       - "dicom"
       - "adapter"

marketplace_confg/chart/dicom-adapter/templates/manifest.yaml

@@ -16,6 +16,7 @@ spec:
       labels: *DicomDeploymentLabels
     spec:
       containers:
+        {{- if or (eq .Values.import.deployment_type "import adapter") (eq .Values.import.deployment_type "both")}}
         - name: dicom-import-adapter
           image: "{{ .Values.import.image.repo }}:{{ .Values.import.image.tag }}"
           ports:
@@ -44,6 +45,9 @@ spec:
             {{- if .Values.import.store_compress_to_transfer_syntax }}
             - "--store_compress_to_transfer_syntax={{ .Values.import.store_compress_to_transfer_syntax }}"
             {{- end }}
+            {{- if .Values.import.custom_flags }}
+            - "{{ .Values.import.custom_flags }}"
+            {{- end }}
             {{- if .Values.import.monitoring_project_id }}
             - "--monitoring_project_id={{ .Values.import.monitoring_project_id }}"
           env:
@@ -58,7 +62,9 @@ spec:
             - name: ENV_CONTAINER_NAME
               value: dicom-import-adapter
             {{- end }}
-        {{- if .Values.export.hasexporter }}
+        {{- end }}
+
+        {{- if or (eq .Values.import.deployment_type "export adapter") (eq .Values.import.deployment_type "both")}}
         - name: dicom-export-adapter
           image: "{{ .Values.export.image.repo }}:{{ .Values.export.image.tag }}"
           args:
@@ -89,6 +95,9 @@ spec:
             {{- if .Values.export.use_gcp_application_default_credentials }}
             - "--use_gcp_application_default_credentials"
             {{- end }}
+            {{- if .Values.export.custom_flags }}
+            - "{{ .Values.export.custom_flags }}"
+            {{- end }}
             {{- if .Values.export.monitoring_project_id }}
             - "--monitoring_project_id={{ .Values.export.monitoring_project_id }}"
             env:

marketplace_confg/chart/dicom-adapter/values.yaml

@@ -2,6 +2,7 @@ import:
   image:
     repo: null
     tag: null
+  deployment_type: null
   dimse_aet: null
   monitoring_project_id: null
   dicomweb_address: null
@@ -11,9 +12,9 @@ import:
   aet_dictionary_inline: null
   destination_config_inline: null
   store_compress_to_transfer_syntax: null
+  custom_flags: null
 export:
   monitoring_project_id: null
-  hasexporter: null
   peer_dimse_aet: null
   peer_dimse_ip: null
   peer_dimse_port: null
@@ -23,6 +24,7 @@ export:
   dicomweb_addr: null
   oauth_scopes: null
   use_gcp_application_default_credentials: null
+  custom_flags: null
   image:
     repo: null
     tag: null

marketplace_confg/schema.yaml

@@ -1,7 +1,7 @@
 x-google-marketplace:
   schemaVersion: v2
   applicationApiVersion: v1beta1
-  publishedVersion: "0.2.1"
+  publishedVersion: "0.2.14"
   publishedVersionMetadata:
     releaseNote: >-
       A first release.
@@ -27,129 +27,161 @@ properties:
     type: string
     x-google-marketplace:
       type: NAMESPACE
-    
+
   lb.internal:
     type: boolean
-    title: "disable external access"
-    description: Set to true for internal access only.
+    title: "Disable external access"
+    description: >-
+      Set to true for internal access in the same VPC network only. Choose false
+      to expose the adapter to an external IP address.
     default: true
     enum:
     - true
     - false
 
+  import.deployment_type:
+      type: string
+      title: Deployment options
+      description: >-
+        Choose adapter components to deploy.
+        for details on importer:
+        https://github.com/GoogleCloudPlatform/
+        healthcare-dicom-dicomweb-adapter#import-adapter,
+        for details on exporter:
+        https://github.com/GoogleCloudPlatform/
+        healthcare-dicom-dicomweb-adapter#export-adapter
+      default: import adapter
+      enum:
+      - import adapter
+      - export adapter
+      - both
   import.dicomweb_address:
     type: string
-    title: "importer - dicom web address"
+    title: "importer - Dicom web address"
     description: >- 
       Address for DicomWeb service. Must be a full path up to /dicomWeb if 
-      the Cloud Healthcare API is used
+      the Cloud Healthcare API is used. e.g. 
+      https://healthcare.googleapis.com/v1/projects/myproject/locations/
+      us-central1/datasets/mydataset/dicomStores/mydicomstore/dicomWeb
   import.dimse_aet:
     type: string
     title: "importer - DIMSE aet"
     description: Title of DIMSE Application Entity
-  import.monitoring_project_id:
-    type: string
-    title: "importer - monitoring project id (Optional)"
-    description: >-
-      "(Optional) Stackdriver monitoring project id, must be the same as the 
-      project id in which the adapter is running."
   import.redact_remove_list:
     type: string
-    title: "importer - redact remove list (Optional)"
+    title: "importer - Redact remove list (Optional)"
     description:  >-
-      "(Optional - Redactor) Tags to remove during C-STORE upload, comma 
-      separated. Only one of 'redact' flags may be present."
+      (Optional - Redactor) Tags to remove during C-STORE upload, comma 
+      separated. Only one of 'redact' flags may be present.
   import.redact_keep_list:
     type: string
-    title: "importer - redact keep list (Optional)"
+    title: "importer - Redact keep list (Optional)"
     description:  >-
-      "(Optional - Redactor) Tags to keep during C-STORE upload, comma separated.
-      Only one of 'redact' flags may be present."
+      (Optional - Redactor) Tags to keep during C-STORE upload, comma separated.
+      Only one of 'redact' flags may be present.
   import.dimse_cmove_aet:
     type: string
     title: "importer - C-MOVE aet (Optional)"
     description:  >-
-      "(Optional - C-MOVE) Separate AET used for C-STORE calls within context of C-MOVE."
+      (Optional - C-MOVE) Separate AET used for C-STORE calls within context of C-MOVE.
+      For details, go to:
+      https://github.com/GoogleCloudPlatform/healthcare-dicom-dicomweb-adapter#import-adapter
   import.aet_dictionary_inline:
     type: string
     title: "importer - Inline aet dictionary (Optional)"
     description:  >-
-      "(Optional - C-MOVE) Json array containing aet definitions (name/host/port per element)"
+      (Optional - C-MOVE) Json array containing aet definitions (name/host/port per element).
+      e.g. [{"name":"DEVICE_A","host":"localhost","port":11113},
+      {"name":"DEVICE_B","host":"192.168.0.1","port": 11114},...]
+      For details, go to:
+      https://github.com/GoogleCloudPlatform/healthcare-dicom-dicomweb-adapter#import-adapter
   import.destination_config_inline:
     type: string
-    title: "importer - destination config inline (Optional)"
+    title: "importer - Destination config inline (Optional)"
     description:  >-
-      "(Optional) Json array containing destination definitions 
-      (filter/dicomweb_destination per element)."
+      (Optional) Json array containing destination definitions 
+      (filter/dicomweb_destination per element).
   import.store_compress_to_transfer_syntax:
     type: string
-    title: "importer - store compress to transfer syntax (Optional)"
+    title: "importer - Store compress to transfer syntax (Optional)"
     description:  >-
-      "(Optional) Transfer Syntax to convert instances to during C-STORE 
-      upload. See Readme for list of supported syntaxes."
+      (Optional) Transfer Syntax to convert instances to during C-STORE 
+      upload. See Readme for list of supported syntaxes.
+  import.monitoring_project_id:
+      type: string
+      title: "importer - Monitoring project id (Optional)"
+      description: >-
+        (Optional) Stackdriver monitoring project id, must be the same as the 
+        project id in which the adapter is running.
+  import.custom_flags:
+      type: string
+      title: "Extra import adapter flag (Optional)"
+      description: >-
+        (Optional) Addtional flag for import adapter.
+        e.g. "--flag_a=valueA"
 
-  export.hasexporter:
-    type: boolean
-    title: Enable dicom exporter
-    description: Set to true if you want to add a dicom exporter to the deployment.
-    default: false
-    enum:
-    - true
-    - false
   export.peer_dimse_aet:
     type: string
-    title: "exporter - peer DIMSE aet"
-    description: "(CStore) Application Entity Title of DIMSE peer."
+    title: "exporter - Peer DIMSE aet"
+    description: (CStore) Application Entity Title of DIMSE peer.
   export.peer_dimse_ip:
     type: string
-    title: "exporter - peer DIMSE IP"
-    description: "(CStore) IP of DIMSE peer."
+    title: "exporter - Peer DIMSE IP"
+    description: (CStore) IP of DIMSE peer.
   export.peer_dimse_port:
     type: integer
-    title: "exporter - peer DIMSE port"
-    description: "(CStore) Port of DIMSE peer."
-  export.peer_dicomweb_address:
-    type: string
-    title: "exporter - peer dicomweb address"
-    description:  >-
-      "(StowRs) Address of peer DicomWeb API serving STOW-RS. Must be a full path up 
-      to /dicomWeb if the Cloud Healthcare API is used."
-  export.use_gcp_application_default_credentials:
-    type: boolean
-    title: "exporter - Enable gcp application default credentials"
-    description:  >-
-      "(StowRs) If true, uses GCP Application Credentials to when sending HTTP requests 
-      to peer. This is useful if the peer DICOMWeb endpoint is running in GCP."
-    enum:
-    - true
-    - false
+    title: "exporter - Peer DIMSE port"
+    description: (CStore) Port of DIMSE peer.
   export.project_id:
     type: string
-    title: "exporter - pubsub project id"
+    title: "exporter - Pubsub project id"
     description:  >-
       Pubsub project id, must be the same as the project id in which the adapter is running.
   export.subscription_id:
     type: string
-    title: "exporter - pubsub subscription id"
+    title: "exporter - Pubsub subscription id"
     description: The pubsub subscription id
   export.dicomweb_addr:
     type: string
-    title: "exporter - dicom web address"
-    description: Address for DicomWeb service that sources the DICOM.
+    title: "exporter - Dicom web address"
+    description: >-
+      Base api endpoint. e.g. 
+      https://healthcare.googleapis.com/v1
   export.oauth_scopes:
     type: string
-    title: "exporter - oauth scopes"
+    title: "exporter - Oauth scopes"
     description: Comma seperated OAuth scopes used by adapter.
     default: "https://www.googleapis.com/auth/pubsub"
+  export.peer_dicomweb_address:
+    type: string
+    title: "exporter - Peer dicomweb address"
+    description:  >-
+      (StowRs) Address of peer DicomWeb API serving STOW-RS. Must be a full path up 
+      to /dicomWeb if the Cloud Healthcare API is used. e.g. 
+      https://healthcare.googleapis.com/v1/projects/myproject/locations/
+      us-central1/datasets/mydataset/dicomStores/mydicomstore/dicomWeb
+  export.use_gcp_application_default_credentials:
+    type: boolean
+    title: "exporter - Enable gcp application default credentials"
+    description:  >-
+      (StowRs) If true, uses GCP Application Credentials to when sending HTTP requests 
+      to peer. This is useful if the peer DICOMWeb endpoint is running in GCP.
+    enum:
+    - true
+    - false
   export.monitoring_project_id:
     type: string
-    title: "exporter - monitoring project id (Optional)"
+    title: "exporter - Monitoring project id (Optional)"
     description:  >-
-      "(Optional) Stackdriver monitoring project id, must be the same as the project 
-      id in which the adapter is running."
+      (Optional) Stackdriver monitoring project id, must be the same as the project 
+      id in which the adapter is running.
+  export.custom_flags:
+      type: string
+      title: "Extra export adapter flag (Optional)"
+      description: >-
+        (Optional) Addtional flag for export adapter.
+        e.g. "--flag_a=valueA"
 
 required:
 - name
-- namespace
-- import.dicomweb_address
-- import.dimse_aet
+- namespace