Merge pull request galaxyproject#18497 from sanjaysrikakulam/update_f…

…ile_and_objectstore_templates Add missing version in the file sources and object store templates
tcollins2011 · Jul 9, 2024 · 4c42548 · 4c42548
2 parents ddc1cc1 + f36ed01
commit 4c42548
Show file tree

Hide file tree

Showing 18 changed files with 24 additions and 27 deletions.
diff --git a/lib/galaxy/files/templates/examples/admin_secrets.yml b/lib/galaxy/files/templates/examples/admin_secrets.yml
@@ -1,4 +1,5 @@
 - id: admin_secret_directory
+  version: 0
   name: Secret Directory
   description: An directory constructed from admin secrets.
   configuration:

diff --git a/lib/galaxy/files/templates/examples/admin_secrets_with_defaults.yml b/lib/galaxy/files/templates/examples/admin_secrets_with_defaults.yml
@@ -1,4 +1,5 @@
 - id: admin_secret_directory
+  version: 0
   name: Secret Directory with Defaults
   description: An directory constructed from admin secrets or defaults.
   configuration:

diff --git a/lib/galaxy/files/templates/examples/production_aws_private_bucket.yml b/lib/galaxy/files/templates/examples/production_aws_private_bucket.yml
@@ -1,6 +1,7 @@
 - id: aws_private
+  version: 0
   name: Amazon Web Services Private Bucket
-  description: Setup access to a private AWS bucket using a secret access key. 
+  description: Setup access to a private AWS bucket using a secret access key.
   configuration:
     type: s3fs
     bucket: "{{ bucket }}"
@@ -26,5 +27,5 @@
   secrets:
     secret_key:
       label: Secret Access Key
-      help: |        
+      help: |
         The "secret access key" as defined in the [Amazon Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
diff --git a/lib/galaxy/files/templates/examples/production_aws_public_bucket.yml b/lib/galaxy/files/templates/examples/production_aws_public_bucket.yml
@@ -1,6 +1,7 @@
 - id: aws_public
+  version: 0
   name: Amazon Web Services Public Bucket
-  description: Setup anonymous access to a public AWS bucket. 
+  description: Setup anonymous access to a public AWS bucket.
   configuration:
     type: s3fs
     bucket: "{{ variables.bucket }}"

diff --git a/lib/galaxy/files/templates/examples/production_s3fs.yml b/lib/galaxy/files/templates/examples/production_s3fs.yml
@@ -1,4 +1,5 @@
 - id: s3fs
+  version: 0
   name: S3 Compatible Storage with Credentials
   description: |
     The APIs used to connect to Amazon's S3 (Simple Storage Service) have become something
@@ -19,7 +20,6 @@
         that is accessing the data. The [Amazon documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)
         calls these an "access key ID", the [CloudFlare documentation](https://developers.cloudflare.com/r2/examples/aws/boto3/)
         describes these as ``aws_access_key_id``.
-
     bucket:
       label: Bucket
       type: string

diff --git a/lib/galaxy/files/templates/examples/s3fs_by_host_and_port.yml b/lib/galaxy/files/templates/examples/s3fs_by_host_and_port.yml
@@ -1,4 +1,5 @@
 - id: s3fs
+  version: 0
   name: S3 Compatible Storage with Credentials
   description: |
     The APIs used to connect to Amazon's S3 (Simple Storage Service) have become something
@@ -19,7 +20,6 @@
         that is accessing the data. The [Amazon documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)
         calls these an "access key ID", the [CloudFlare documentation](https://developers.cloudflare.com/r2/examples/aws/boto3/)
         describes these as ``aws_access_key_id``.
-
     bucket:
       label: Bucket
       type: string
@@ -34,13 +34,12 @@
       help: |
         The [hostname](https://en.wikipedia.org/wiki/Hostname) used to connect to the target
         S3 compatible service.
-        
+
         If the documentation for your storage service has something called an ``endpoint_url``,
         this can be used to determine this value. For instance, the CloudFlare documentation
         describes its endpoints as ``https://<accountid>.r2.cloudflarestorage.com``. Here
         you would substitute your CloudFlare account ID into the endpoint and shave off the ``https://``,
         so if your account ID was ``galactian``, you would enter ``galactian.r2.cloudflarestorage.com``.
-
     port:
       label: Connection Port
       type: integer

diff --git a/lib/galaxy/files/templates/examples/templating_override.yml b/lib/galaxy/files/templates/examples/templating_override.yml
@@ -1,4 +1,5 @@
 - id: project_disk
+  version: 0
   name: Project Disk
   description: |
     Disk in our institutional ``/data`` directory for you user's project.""

diff --git a/lib/galaxy/objectstore/templates/examples/cloudflare.yml b/lib/galaxy/objectstore/templates/examples/cloudflare.yml
@@ -1,27 +1,25 @@
 # https://developers.cloudflare.com/r2/examples/aws/boto3/
 - id: cloudflare
+  version: 0
   name: CloudFlare R2
   description: |
     This template can be used to connect to your [CloudFlare R2](https://developers.cloudflare.com/r2/)
     storage. To use these templates you will need to generate
     [CloudFlare R2 access tokens](https://developers.cloudflare.com/r2/api/s3/tokens/).
     Following that tutorial, you should have an "Account ID", and "Access Key ID", and a
     "Secret Access Key".
-
   variables:
     access_key:
       label: Access Key ID
       type: string
       help: |
         An Access Key ID generated according to the
         [CloudFlare R2 access tokens documentation](https://developers.cloudflare.com/r2/api/s3/tokens/).
-
     account_id:
       label: Account ID
       type: string
       help: |
         Your account ID as available in the [CloudFlare dashboard](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/).
-
     bucket:
       label: Bucket
       type: string
@@ -34,7 +32,6 @@
       help: |
         A Secret Access Key generated according to the
         [CloudFlare R2 access tokens documentation](https://developers.cloudflare.com/r2/api/s3/tokens/).
-
   configuration:
     type: boto3
     auth:

diff --git a/lib/galaxy/objectstore/templates/examples/cloudflare_legacy.yml b/lib/galaxy/objectstore/templates/examples/cloudflare_legacy.yml
@@ -1,27 +1,25 @@
 # https://developers.cloudflare.com/r2/examples/aws/boto3/
 - id: cloudflare_legacy
+  version: 0
   name: CloudFlare R2
   description: |
     This template can be used to connect to your [CloudFlare R2](https://developers.cloudflare.com/r2/)
     storage. To use these templates you will need to generate
     [CloudFlare R2 access tokens](https://developers.cloudflare.com/r2/api/s3/tokens/).
     Following that tutorial, you should have an "Account ID", and "Access Key ID", and a
     "Secret Access Key".
-
   variables:
     access_key:
       label: Access Key ID
       type: string
       help: |
         An Access Key ID generated according to the
         [CloudFlare R2 access tokens documentation](https://developers.cloudflare.com/r2/api/s3/tokens/).
-
     account_id:
       label: Account ID
       type: string
       help: |
         Your account ID as available in the [CloudFlare dashboard](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/).
-
     bucket:
       label: Bucket
       type: string
@@ -34,7 +32,6 @@
       help: |
         A Secret Access Key generated according to the
         [CloudFlare R2 access tokens documentation](https://developers.cloudflare.com/r2/api/s3/tokens/).
-
   configuration:
     type: generic_s3
     auth:

diff --git a/lib/galaxy/objectstore/templates/examples/minio_example.yml b/lib/galaxy/objectstore/templates/examples/minio_example.yml
@@ -1,4 +1,5 @@
 - id: minio
+  version: 0
   name: Institutional S3 Storage
   description: Connect to our institutional MinIO storage service.
   variables:

diff --git a/lib/galaxy/objectstore/templates/examples/minio_just_buckets.yml b/lib/galaxy/objectstore/templates/examples/minio_just_buckets.yml
@@ -1,4 +1,5 @@
 - id: lab_minio_storage
+  version: 0
   name: Lab Storage
   description: Connect to our lab's local MinIO storage service.
   variables:

diff --git a/lib/galaxy/objectstore/templates/examples/minio_just_buckets_legacy.yml b/lib/galaxy/objectstore/templates/examples/minio_just_buckets_legacy.yml
@@ -1,4 +1,5 @@
 - id: lab_minio_storage_legacy
+  version: 0
   name: Lab Storage (Legacy)
   description: Connect to our lab's local MinIO storage service.
   variables:

diff --git a/lib/galaxy/objectstore/templates/examples/production_aws_s3.yml b/lib/galaxy/objectstore/templates/examples/production_aws_s3.yml
@@ -1,4 +1,5 @@
 - id: aws_s3
+  version: 0
   name: Amazon Web Services S3 Storage
   description: |
     Amazon's Simple Storage Service (S3) is Amazon's primary cloud storage service.
@@ -10,7 +11,7 @@
       help: |
         A security credential for interacting with AWS services can be created from your
         AWS web console. Creating an "Access Key" creates a pair of keys used to identify
-        and authenticate access to your AWS account - the first part of the pair  is 
+        and authenticate access to your AWS account - the first part of the pair  is
         "Access Key ID" and should be entered here. The second part of your key is the secret
         part called the "Secret Access Key". Place that in the secure part of this form below.
     bucket:
@@ -25,7 +26,6 @@
       label: Secret Access Key
       help: |
         See the documentation above used "Access Key ID" for information about access key pairs.
-
   configuration:
     type: boto3
     auth:

diff --git a/lib/galaxy/objectstore/templates/examples/production_aws_s3_legacy.yml b/lib/galaxy/objectstore/templates/examples/production_aws_s3_legacy.yml
@@ -1,4 +1,5 @@
 - id: aws_s3_legacy
+  version: 0
   name: Amazon Web Services S3 Storage (Legacy)
   description: |
     Amazon's Simple Storage Service (S3) is Amazon's primary cloud storage service.
@@ -10,7 +11,7 @@
       help: |
         A security credential for interacting with AWS services can be created from your
         AWS web console. Creating an "Access Key" creates a pair of keys used to identify
-        and authenticate access to your AWS account - the first part of the pair  is 
+        and authenticate access to your AWS account - the first part of the pair  is
         "Access Key ID" and should be entered here. The second part of your key is the secret
         part called the "Secret Access Key". Place that in the secure part of this form below.
     bucket:

diff --git a/lib/galaxy/objectstore/templates/examples/production_azure_blob.yml b/lib/galaxy/objectstore/templates/examples/production_azure_blob.yml
@@ -8,10 +8,8 @@
     auth:
       account_name: '{{ variables.account_name }}'
       account_key: '{{ secrets.account_key}}'
-
     container:
       name: '{{ variables.container_name }}'
-
   variables:
     container_name:
       label: Container Name
@@ -25,7 +23,6 @@
       help: |
         The name of your Azure Blob Storage account. More information on containers can be found in the
         [Azure Storage documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
-
   secrets:
     account_key:
       label: Account Key

diff --git a/lib/galaxy/objectstore/templates/examples/production_gcp_s3.yml b/lib/galaxy/objectstore/templates/examples/production_gcp_s3.yml
@@ -1,5 +1,6 @@
 # https://cloud.google.com/storage/docs/aws-simple-migration
 - id: gcp_s3_interop
+  version: 0
   name: Google Cloud Storage
   description: |
     This template can be used to connect to your [Google Cloud Storage](https://cloud.google.com/storage).
@@ -16,7 +17,6 @@
       help: |
         This will be given to you by Google when you generate [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys)
         to use your storage.
-
     bucket:
       label: Bucket
       type: string
@@ -30,7 +30,6 @@
         This will be given to you by Google when you generate [HMAC Keys](https://cloud.google.com/storage/docs/authentication/hmackeys)
         to use your storage. It should be 40 characters long and look something like the example used
         the Google documentation - `bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ`.
-
   configuration:
     type: boto3
     auth:

diff --git a/lib/galaxy/objectstore/templates/examples/production_generic_s3.yml b/lib/galaxy/objectstore/templates/examples/production_generic_s3.yml
@@ -1,4 +1,5 @@
 - id: generic_s3
+  version: 0
   name: Any S3 Compatible Storage
   description: |
     The APIs used to connect to Amazon's S3 (Simple Storage Service) have become something
@@ -20,7 +21,6 @@
         the [CloudFlare documentation](https://developers.cloudflare.com/r2/examples/aws/boto3/)
         describes these as ``aws_access_key_id``. Internally to Galaxy, we often just call
         this the ``access_key``.
-
     bucket:
       label: Bucket
       type: string

diff --git a/lib/galaxy/objectstore/templates/examples/production_generic_s3_legacy.yml b/lib/galaxy/objectstore/templates/examples/production_generic_s3_legacy.yml
@@ -1,4 +1,5 @@
 - id: generic_s3_legacy
+  version: 0
   name: Any S3 Compatible Storage (Legacy)
   description: |
     The APIs used to connect to Amazon's S3 (Simple Storage Service) have become something
@@ -20,7 +21,6 @@
         the [CloudFlare documentation](https://developers.cloudflare.com/r2/examples/aws/boto3/)
         describes these as ``aws_access_key_id``. Internally to Galaxy, we often just call
         this the ``access_key``.
-
     bucket:
       label: Bucket
       type: string
@@ -35,13 +35,12 @@
       help: |
         The [hostname](https://en.wikipedia.org/wiki/Hostname) used to connect to the target
         S3 compatible service.
-        
+
         If the documentation for your storage service has something called an ``endpoint_url``,
         this can be used to determine this value. For instance, the CloudFlare documentation
         describes its endpoints as ``https://<accountid>.r2.cloudflarestorage.com``. Here
         you would substitute your CloudFlare account ID into the endpoint and shave off the ``https://``,
         so if your account ID was ``galactian``, you would enter ``galactian.r2.cloudflarestorage.com``.
-
     port:
       label: Connection Port
       type: integer