Run prettier in yaml and md files (#2746)

vmware-tanzu · May 3, 2021 · a90911b · a90911b
1 parent 4a2a98c
commit a90911b
Show file tree

Hide file tree

Showing 50 changed files with 983 additions and 879 deletions.
diff --git a/README.md b/README.md
@@ -13,15 +13,15 @@ Kubeapps is a web-based UI for deploying and managing applications in Kubernetes
 
 ## Quick Start
 
-Use the Helm chart to install the latest version of Kubeapps: 
+Use the Helm chart to install the latest version of Kubeapps:
 
 ```bash
 helm repo add bitnami https://charts.bitnami.com/bitnami
 kubectl create namespace kubeapps
 helm install kubeapps --namespace kubeapps bitnami/kubeapps
-``` 
+```
 
-***Note:*** Kubeapps 2.0 and onwards supports Helm 3 only. While only the Helm 3 API is supported, in most cases, charts made for Helm 2 will still work. For detailed instructions on how to install and use Kubeapps follow the [Getting Started Guide](./docs/user/getting-started.md).
+**_Note:_** Kubeapps 2.0 and onwards supports Helm 3 only. While only the Helm 3 API is supported, in most cases, charts made for Helm 2 will still work. For detailed instructions on how to install and use Kubeapps follow the [Getting Started Guide](./docs/user/getting-started.md).
 
 > Please also take into account that Kubeapps is using the [Bitnami chart](https://github.com/bitnami/charts/tree/master/bitnami/kubeapps) as the official one. The chart inside this repository is only intended to be used for development purposes.
 
@@ -50,7 +50,6 @@ Whereas Kubeapps does not have yet a well-designed API, we still want to share t
 
 Feel free to contribute using this guide on [how to update the API docs](./docs/developer/update-api-docs.md) and send us a PR if you find any errors.
 
-
 > This API documentation is subject to change in each Kubeapps version. If you are interested in the Kubeapps API, please [reach out to us](https://kubernetes.slack.com/messages/kubeapps) for further information.
 
 ## Differences from Monocular

diff --git a/cmd/apprepository-controller/artifacts/examples/crd.yaml b/cmd/apprepository-controller/artifacts/examples/crd.yaml
@@ -9,5 +9,5 @@ spec:
     kind: AppRepository
     plural: apprepositories
     shortNames:
-    - apprepos
+      - apprepos
   scope: Namespaced
diff --git a/cmd/asset-syncer/testdata/empty-repo-index.yaml b/cmd/asset-syncer/testdata/empty-repo-index.yaml
@@ -1 +1 @@
-entries:
+entries:
diff --git a/cmd/asset-syncer/testdata/valid-index.yaml b/cmd/asset-syncer/testdata/valid-index.yaml
@@ -1,69 +1,69 @@
 entries:
   acs-engine-autoscaler:
-  - apiVersion: v1
-    appVersion: 2.1.1
-    created: 2017-12-06T18:48:59.568323124Z
-    description: Scales worker nodes within agent pools
-    digest: 39e66eb53c310529bd9dd19776f8ba662e063a4ebd51fc5ec9f2267e2e073e3e
-    icon: https://github.com/kubernetes/kubernetes/blob/master/logo/logo.png
-    maintainers:
-    - email: ritazh@microsoft.com
-      name: ritazh
-    - email: wibuch@microsoft.com
-      name: wbuchwalter
-    name: acs-engine-autoscaler
-    sources:
-    - https://github.com/wbuchwalter/Kubernetes-acs-engine-autoscaler
-    urls:
-    - https://kubernetes-charts.storage.googleapis.com/acs-engine-autoscaler-2.1.1.tgz
-    version: 2.1.1
+    - apiVersion: v1
+      appVersion: 2.1.1
+      created: 2017-12-06T18:48:59.568323124Z
+      description: Scales worker nodes within agent pools
+      digest: 39e66eb53c310529bd9dd19776f8ba662e063a4ebd51fc5ec9f2267e2e073e3e
+      icon: https://github.com/kubernetes/kubernetes/blob/master/logo/logo.png
+      maintainers:
+        - email: ritazh@microsoft.com
+          name: ritazh
+        - email: wibuch@microsoft.com
+          name: wbuchwalter
+      name: acs-engine-autoscaler
+      sources:
+        - https://github.com/wbuchwalter/Kubernetes-acs-engine-autoscaler
+      urls:
+        - https://kubernetes-charts.storage.googleapis.com/acs-engine-autoscaler-2.1.1.tgz
+      version: 2.1.1
   wordpress:
-  - appVersion: 4.9.1
-    created: 2017-12-06T18:48:59.644981487Z
-    description: new description!
-    digest: 74889e60a35dcffa4686f88bb23de863fed2b6e63a69b1f4858dde37c301885c
-    engine: gotpl
-    home: http://www.wordpress.com/
-    icon: https://bitnami.com/assets/stacks/wordpress/img/wordpress-stack-220x234.png
-    keywords:
-    - wordpress
-    - cms
-    - blog
-    - http
-    - web
-    - application
-    - php
-    maintainers:
-    - email: containers@bitnami.com
-      name: bitnami-bot
-    name: wordpress
-    sources:
-    - https://github.com/bitnami/bitnami-docker-wordpress
-    urls:
-    - https://kubernetes-charts.storage.googleapis.com/wordpress-0.7.5.tgz
-    version: 0.7.5
-  - appVersion: 4.9.0
-    created: 2017-12-01T11:49:00.136950565Z
-    description: Web publishing platform for building blogs and websites.
-    digest: a69139ef3008eeb11ca60261ec2ded61e84ce7db32bb3626056e84bcff7ec270
-    engine: gotpl
-    home: http://www.wordpress.com/
-    icon: https://bitnami.com/assets/stacks/wordpress/img/wordpress-stack-220x234.png
-    keywords:
-    - wordpress
-    - cms
-    - cms
-    - blog
-    - http
-    - web
-    - application
-    - php
-    maintainers:
-    - email: containers@bitnami.com
-      name: bitnami-bot
-    name: wordpress
-    sources:
-    - https://github.com/bitnami/bitnami-docker-wordpress
-    urls:
-    - https://kubernetes-charts.storage.googleapis.com/wordpress-0.7.4.tgz
-    version: 0.7.4
+    - appVersion: 4.9.1
+      created: 2017-12-06T18:48:59.644981487Z
+      description: new description!
+      digest: 74889e60a35dcffa4686f88bb23de863fed2b6e63a69b1f4858dde37c301885c
+      engine: gotpl
+      home: http://www.wordpress.com/
+      icon: https://bitnami.com/assets/stacks/wordpress/img/wordpress-stack-220x234.png
+      keywords:
+        - wordpress
+        - cms
+        - blog
+        - http
+        - web
+        - application
+        - php
+      maintainers:
+        - email: containers@bitnami.com
+          name: bitnami-bot
+      name: wordpress
+      sources:
+        - https://github.com/bitnami/bitnami-docker-wordpress
+      urls:
+        - https://kubernetes-charts.storage.googleapis.com/wordpress-0.7.5.tgz
+      version: 0.7.5
+    - appVersion: 4.9.0
+      created: 2017-12-01T11:49:00.136950565Z
+      description: Web publishing platform for building blogs and websites.
+      digest: a69139ef3008eeb11ca60261ec2ded61e84ce7db32bb3626056e84bcff7ec270
+      engine: gotpl
+      home: http://www.wordpress.com/
+      icon: https://bitnami.com/assets/stacks/wordpress/img/wordpress-stack-220x234.png
+      keywords:
+        - wordpress
+        - cms
+        - cms
+        - blog
+        - http
+        - web
+        - application
+        - php
+      maintainers:
+        - email: containers@bitnami.com
+          name: bitnami-bot
+      name: wordpress
+      sources:
+        - https://github.com/bitnami/bitnami-docker-wordpress
+      urls:
+        - https://kubernetes-charts.storage.googleapis.com/wordpress-0.7.4.tgz
+      version: 0.7.4
diff --git a/docs/architecture/design-proposals/README.md b/docs/architecture/design-proposals/README.md
@@ -5,17 +5,16 @@ This folder contains documents/links used to design new features for Kubeapps.
 # Links
 
 - Authentication (AuthN) and Authorization (AuthZ):
-    - [Introduction](./authentication-and-authorization.md)
-    - [OAuth 2 - OpenID Connect (OIDC) Support](https://docs.google.com/document/d/1YZzLtIbS2copQJgspFiMd0eAhpyt8u19MUSDEvH2X4g)
+  - [Introduction](./authentication-and-authorization.md)
+  - [OAuth 2 - OpenID Connect (OIDC) Support](https://docs.google.com/document/d/1YZzLtIbS2copQJgspFiMd0eAhpyt8u19MUSDEvH2X4g)
 - Dashboard:
-    - [Dashboard Error Handling](./dashboard/error-handling/error-handling.md)
-    - [Simpler deployments](./dashboard/deployment-improvements.md)
-    - [Improve UX in application view](./dashboard/application-view-revamp.md)
-    - [Upgrade to Clarity design](./clarity-ui.md)
+  - [Dashboard Error Handling](./dashboard/error-handling/error-handling.md)
+  - [Simpler deployments](./dashboard/deployment-improvements.md)
+  - [Improve UX in application view](./dashboard/application-view-revamp.md)
+  - [Upgrade to Clarity design](./clarity-ui.md)
 - [Notify Available Chart Updates](https://docs.google.com/document/d/1oG9nerd5CurWSIwH33kKCsOCtkSFMgcm8SuTJyuSnxs/)
 - [Operators support](./operators-support-poc.md)
 - [Third party integration for adding a chart repository](./third-party-add-repository.md)
 - [Replacing MongoDB support](./replacing-mongodb.md)
 - [Helm 3 support](./helm3.md)
 - [Multicluster support](./multi-cluster-support.md)
-
diff --git a/docs/architecture/design-proposals/authentication-and-authorization.md b/docs/architecture/design-proposals/authentication-and-authorization.md
@@ -21,18 +21,18 @@ As described above, this is a solved problem in Kubernetes through the use of Ku
 
 ## Goals and Non-Goals
 
-* Enable using user provided Kubernetes credentials to access Kubernetes APIs from the UI
-* Leverage existing Kubernetes RBAC roles to restrict unauthorized operations, providing a mechanism to restrict operations by namespaces or type (Helm, Kubeless, Service Catalog, etc.)
-* Support the ability to expose Kubeapps externally in a secure way, enabling easier access to Kubeapps without having to install the CLI
-* Avoid introducing a separate way to manage access and authorization to Kubernetes resources (e.g. Kubeapps internal user database)
-* Don't support every possible Kubernetes authentication provider & method
+- Enable using user provided Kubernetes credentials to access Kubernetes APIs from the UI
+- Leverage existing Kubernetes RBAC roles to restrict unauthorized operations, providing a mechanism to restrict operations by namespaces or type (Helm, Kubeless, Service Catalog, etc.)
+- Support the ability to expose Kubeapps externally in a secure way, enabling easier access to Kubeapps without having to install the CLI
+- Avoid introducing a separate way to manage access and authorization to Kubernetes resources (e.g. Kubeapps internal user database)
+- Don't support every possible Kubernetes authentication provider & method
 
 ## User Stories
 
-* As a cluster operator, I want to expose Kubeapps externally but only let authorized users perform certain operations
-* As a member of one engineering team in an organization, I want the ability to deploy and manage applications within my team's namespaces, but I don't want to have access to another team's applications
-* As an SRE, I want to provide my team access to view the state of running applications in the cluster, but I don't want to give out write access to create or delete applications
-* As an SRE, I want to restrict access to provision more expensive service plans from the Service Catalog
+- As a cluster operator, I want to expose Kubeapps externally but only let authorized users perform certain operations
+- As a member of one engineering team in an organization, I want the ability to deploy and manage applications within my team's namespaces, but I don't want to have access to another team's applications
+- As an SRE, I want to provide my team access to view the state of running applications in the cluster, but I don't want to give out write access to create or delete applications
+- As an SRE, I want to restrict access to provision more expensive service plans from the Service Catalog
 
 ## Methods of Authentication
 

diff --git a/docs/architecture/design-proposals/dashboard/application-view-revamp.md b/docs/architecture/design-proposals/dashboard/application-view-revamp.md
@@ -8,10 +8,10 @@ Parent issue: https://github.com/kubeapps/kubeapps/issues/1524
 
 The goal of this revamp is to improve the Application View, which is one of the core views of the project so it gives a better user experience in different areas:
 
- - Discoverability. It should be possible to obtain information about the application dependencies. For example, Kubeapps should show that MariaDB is a dependency of WordPress. Details at https://github.com/kubeapps/kubeapps/issues/529
- - Error Detection. Make an easy to understand view that can point the user to the piece(s) of the chart that is failing.
- - Usability. Make it easier, if possible, to modify/upgrade/rollback/test/delete an application.
- - Debugging. When something fails while working with a release, it should be possible to detect the cause of the issue and fix it without the need of a terminal. This means being able to report kubernetes events/errors to the user and being able to read logs.
+- Discoverability. It should be possible to obtain information about the application dependencies. For example, Kubeapps should show that MariaDB is a dependency of WordPress. Details at https://github.com/kubeapps/kubeapps/issues/529
+- Error Detection. Make an easy to understand view that can point the user to the piece(s) of the chart that is failing.
+- Usability. Make it easier, if possible, to modify/upgrade/rollback/test/delete an application.
+- Debugging. When something fails while working with a release, it should be possible to detect the cause of the issue and fix it without the need of a terminal. This means being able to report kubernetes events/errors to the user and being able to read logs.
 
 ## Action Items
 
@@ -72,7 +72,7 @@ The current list of URLs can be improved with two small changes:
 
 Finally, we can show a single resource table with all the resources so users can inspect in detail the different resources of the application without adding too much noise to the view. Apart from the list of resources we are currently showing, we can add the list of pods related to the application (the ones that are related to a Deployment/Statefulset/Daemonset).
 
-Apart from the basic information of the resource, we could add a summary (human-friendly) to know the status of the resource if possible. 
+Apart from the basic information of the resource, we could add a summary (human-friendly) to know the status of the resource if possible.
 
 We can also show different buttons in order to show the resource YAML, description and logs if available (available for pods, services and workloads).
 

diff --git a/docs/architecture/design-proposals/dashboard/deployment-improvements.md b/docs/architecture/design-proposals/dashboard/deployment-improvements.md
@@ -22,7 +22,7 @@ And for the advanced tab:
 
 <img src="./img/deployment-form-adv.png" width="500px">
 
-*Note that the design may vary, the final proposal will be submitted in a different PR
+\*Note that the design may vary, the final proposal will be submitted in a different PR
 
 Once a user has deployed the application, when trying to upgrade, the basic form should be shown. The form will be pre-filled with the values of the previous version. When switching to a new version, those basic parameters should be maintained.
 
@@ -38,9 +38,9 @@ This JSON Schema allows us to know the structure of the `values.yaml` file but,
 
 We should decide the first subset of applications and parameters that we want to support in order to deliver the first version of this feature. Based on the popularity of the charts managed by Bitnami that are installed through Kubeapps, we have selected:
 
-1.	bitnami/wordpress
-2.	bitnami/apache
-3.	bitnami/postgresql
+1. bitnami/wordpress
+2. bitnami/apache
+3. bitnami/postgresql
 
 Based on those applications, the first batch of parameters we can support is:
 
@@ -68,15 +68,23 @@ Note that we should be able to represent any parameter in a generic way. We are
 Based on the above parameters, this may be an example of a JSON Schema for WordPress:
 
 ```json
-{ 
+{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
 
   "properties": {
-    "wordpressUsername": { "type": "string", "title": "Username", "form": "username" },
-    "wordpressPassword": { "type": "string", "title": "Password", "form": "password" },
+    "wordpressUsername": {
+      "type": "string",
+      "title": "Username",
+      "form": "username"
+    },
+    "wordpressPassword": {
+      "type": "string",
+      "title": "Password",
+      "form": "password"
+    },
     "wordpressEmail": { "type": "string", "title": "Email", "form": "email" },
-    "mariadb": { 
+    "mariadb": {
       "type": "object",
       "properties": {
         "enabled": { "type": "boolean", "title": "Enable External Database" }
@@ -101,10 +109,7 @@ Based on the above parameters, this may be an example of a JSON Schema for WordP
           "type": "string",
           "title": "Disk Size",
           "form": "diskSize",
-          "anyOf": [
-            {"pattern": ".*"},
-            {"enum": ["10Gi", "50Gi", "100Gi"]},
-          ]
+          "anyOf": [{ "pattern": ".*" }, { "enum": ["10Gi", "50Gi", "100Gi"] }]
         }
       }
     },
@@ -132,14 +137,27 @@ Based on the above parameters, this may be an example of a JSON Schema for WordP
               ]
             }
           }
-        },
+        }
       }
     },
-    "enableMetrics": { "type": "boolean", "title": "Enable Metrics", "form": "enableMetrics" },
-    "replicas": { "type": "integer", "title": "Number of Replicas", "form": "replicas" }
+    "enableMetrics": {
+      "type": "boolean",
+      "title": "Enable Metrics",
+      "form": "enableMetrics"
+    },
+    "replicas": {
+      "type": "integer",
+      "title": "Number of Replicas",
+      "form": "replicas"
+    }
   },
 
-  "required": ["wordpressUsername", "wordpressEmail", "persistence", "resources"],
+  "required": [
+    "wordpressUsername",
+    "wordpressEmail",
+    "persistence",
+    "resources"
+  ]
 }
 ```