Skip to content
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.

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

Update names and descriptions for services. #3632

Merged
merged 5 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion templates/shared_services/certs/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-shared-service-certs
version: 0.5.0
version: 0.5.1
description: "An Azure TRE shared service to generate certificates for a specified internal domain using Letsencrypt"
registry: azuretre
dockerfile: Dockerfile.tmpl
Expand Down
16 changes: 15 additions & 1 deletion templates/shared_services/certs/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,27 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/shared_services/certs/template_schema.json",
"type": "object",
"title": "Certs Service",
"title": "Certificate Service",
"description": "Provides SSL Certs for a specified internal domain",
"required": [
"domain_prefix",
"cert_name"
],
"properties": {
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "Certificate Service",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "Provides an SSL certificate for a specified internal domain",
"updateable": true
},
"domain_prefix": {
"$id": "#/properties/domain_prefix",
"type": "string",
Expand Down
4 changes: 2 additions & 2 deletions templates/shared_services/databricks-auth/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
schemaVersion: 1.0.0
name: tre-shared-service-databricks-private-auth
version: 0.1.1
description: "An Azure TRE shared service for Azure Databricks autnetication."
version: 0.1.2
description: "An Azure TRE shared service for Azure Databricks authentication."
registry: azuretre
dockerfile: Dockerfile.tmpl

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
"type": "string",
"title": "Description of the shared service",
"description": "The description of the shared service to be displayed to users",
"default": "Azure Databricks Private Authentication Shared Service is a Databricks workspace that you create in the same region as your Azure Databricks workspaces, and its only purpose is hosting the browser authentication private endpoint connection for your actual production Azure Databricks workspaces in that region. The private web auth workspace is not used for anything else but authentication.",
"default": "Hosts the browser authentication private endpoint connection for your Azure Databricks workspaces.",
"updateable": true
},
"overview": {
"type": "string",
"title": "Overview for the shared service",
"description": "Long form description of the shared service, in markdown syntax",
"default": "Azure Databricks Private Authentication Shared Service is a Databricks workspace that you create in the same region as your Azure Databricks workspaces, and its only purpose is hosting the browser authentication private endpoint connection for your actual production Azure Databricks workspaces in that region. The private web auth workspace is not used for anything else but authentication.\n[Enable Azure Private Link as a simplified deployment](https://learn.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/private-link-simplified)",
"default": "Azure Databricks Private Authentication Shared Service is a Databricks workspace that in the same region as your Azure Databricks workspaces, and its only purpose is hosting the browser authentication private endpoint connection for your Azure Databricks workspace services.",
"updateable": true
}
}
Expand Down
2 changes: 1 addition & 1 deletion templates/shared_services/gitea/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-shared-service-gitea
version: 0.6.1
version: 0.6.2
description: "A Gitea shared service"
dockerfile: Dockerfile.tmpl
registry: azuretre
Expand Down
28 changes: 25 additions & 3 deletions templates/shared_services/gitea/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,32 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/shared_services/gitea/template_schema.json",
"type": "object",
"title": "Gitea Shared Service",
"description": "Provides Gitea shared service",
"title": "Gitea - Git Mirror",
"description": "The Gitea shared service is typically used for mirroring external Git repositories.",
"required": [],
"properties": {},
"properties": {
marrobi marked this conversation as resolved.
Show resolved Hide resolved
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "Git Mirror",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "Access mirrored Git repositories.",
"updateable": true
},
"overview": {
"type": "string",
"title": "Workspace Service Overview",
"description": "Long form description of the workspace service, in markdown syntax",
"default": "The Gitea shared service is used for mirroring external Git repositories. For instructions on how to create Git mirrors see [https://docs.gitea.com/usage/repo-mirror](https://docs.gitea.com/usage/repo-mirror).",
"updateable": true
}
},
"pipeline": {
"install": [
{
Expand Down
2 changes: 1 addition & 1 deletion templates/shared_services/sonatype-nexus-vm/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-shared-service-sonatype-nexus
version: 2.5.2
version: 2.5.3
description: "A Sonatype Nexus shared service"
dockerfile: Dockerfile.tmpl
registry: azuretre
Expand Down
28 changes: 24 additions & 4 deletions templates/shared_services/sonatype-nexus-vm/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,37 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/shared_services/sonatype-nexus-vm/template_schema.json",
"type": "object",
"title": "Nexus Shared Service",
"description": "Provides Nexus shared service",
"title": "Sonatype Nexus Repository Manager",
"description": "Sonatype Nexus is a repository manager that helps you manage components, binaries and build artifacts. It's proxy functionality enables users without public Internet connectivity to access software packages.",
"required": [
"ssl_cert_name"
],
"properties": {
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "Package Mirror",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "Access software packages via Sonatype Nexus Repository Manager.",
"updateable": true
},
"overview": {
"type": "string",
"title": "Workspace Service Overview",
"description": "Long form description of the workspace service, in markdown syntax",
"default": "Sonatype Nexus is a repository manager that helps you manage components, binaries and build artifacts. It's proxy functionality enables users without public Internet connectivity to access software packages. To understand how to work with different package formats, please review the documentation here: [https://help.sonatype.com/repomanager3/nexus-repository-administration/formats](https://help.sonatype.com/repomanager3/nexus-repository-administration/formats).",
"updateable": true
},
"ssl_cert_name": {
"type": "string",
"title": "SSL certificate name",
"description": "The name of the certificate to use (located in the core KeyVault) for configuring Nexus SSL",
"default": "nexus-ssl"
"description": "The name of the certificate to use (located in the core KeyVault) for configuring Nexus SSL"
}
},
"pipeline": {
Expand Down
2 changes: 1 addition & 1 deletion templates/workspace_services/gitea/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-workspace-service-gitea
version: 0.8.1
version: 0.8.2
description: "A Gitea workspace service"
dockerfile: Dockerfile.tmpl
registry: azuretre
Expand Down
25 changes: 23 additions & 2 deletions templates/workspace_services/gitea/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,32 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/workspace_services/guacamole/template_schema.json",
"type": "object",
"title": "Gitea Workspace Service",
"description": "Provides Git services within the workspace",
"title": "Gitea",
"description": "Gitea is a lightweight DevOps platform. Features include code hosting, code review, CI/CD, project management and package management.",
"required": [
],
"properties": {
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "Gitea",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "Gitea is a lightweight DevOps platform. Features include code hosting, code review, CI/CD, project management and package management.",
"updateable": true
},
"overview": {
"type": "string",
"title": "Workspace Service Overview",
"description": "Long form description of the workspace service, in markdown syntax",
"default": "Gitea is a lightweight DevOps platform. Features include code hosting, code review, CI/CD, project management and package management. Documentation can be found here: [https://docs.gitea.com/](https://docs.gitea.com/).",
"updateable": true
}
},
"pipeline": {
"install": [
Expand Down
2 changes: 1 addition & 1 deletion templates/workspace_services/guacamole/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-service-guacamole
version: 0.9.3
version: 0.9.4
description: "An Azure TRE service for Guacamole"
dockerfile: Dockerfile.tmpl
registry: azuretre
Expand Down
23 changes: 22 additions & 1 deletion templates/workspace_services/guacamole/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,31 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/workspace_services/guacamole/template_schema.json",
"type": "object",
"title": "Virtual Desktop Service",
"title": "Apache Guacamole - Virtual Desktop Service",
"description": "Enables Windows and Linux virtual machines to be accessed via Apache Guacamole.",
"required": [],
"properties": {
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "Virtual Desktops",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "Access Windows and Linux virtual machines via Apache Guacamole",
"updateable": true
},
"overview": {
"type": "string",
"title": "Workspace Service Overview",
"description": "Long form description of the workspace service, in markdown syntax",
"default": "Access Windows and Linux virtual machines via Apache Guacamole. Documentation for using this service can be found here: [https://guacamole.apache.org/doc/gug/using-guacamole.html](https://guacamole.apache.org/doc/gug/using-guacamole.html)",
"updateable": true
},
"guac_disable_copy": {
"$id": "#/properties/guac_disable_copy",
"type": "boolean",
Expand Down
2 changes: 1 addition & 1 deletion templates/workspace_services/mlflow/porter.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
schemaVersion: 1.0.0
name: tre-service-mlflow
version: 0.7.1
version: 0.7.2
description: "An Azure TRE service for MLflow machine learning lifecycle"
dockerfile: Dockerfile.tmpl
registry: azuretre
Expand Down
27 changes: 24 additions & 3 deletions templates/workspace_services/mlflow/template_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,29 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://github.com/microsoft/AzureTRE/templates/workspace_services/mlflow/template_schema.json",
"type": "object",
"title": "MLflow machine learning lifecycle",
"description": "Deploys MLflow server to manage machine learning lifecycle.",
"title": "MLflow",
"description": "MLflow server to manage machine learning lifecycle.",
"required": [],
"properties": {}
"properties": {
"display_name": {
"type": "string",
"title": "Name for the workspace service",
"description": "The name of the workspace service to be displayed to users",
"default": "MLflow",
"updateable": true
},
"description": {
"type": "string",
"title": "Description of the workspace service",
"description": "Description of the workspace service",
"default": "MLflow is an open source platform to manage the ML lifecycle, including experimentation, reproducibility, deployment, and a central model registry.",
"updateable": true
},
"overview": {
"type": "string",
"title": "Workspace Service Overview",
"description": "Long form description of the workspace service, in markdown syntax",
"default": "MLflow is an open source platform to manage the ML lifecycle, including experimentation, reproducibility, deployment, and a central model registry. Documentation can be found here: [https://mlflow.org/docs/latest/index.html](https://mlflow.org/docs/latest/index.html)"
}
}
}