From 32cb790b1d3da3dfc5f509b88e4dbd4754444894 Mon Sep 17 00:00:00 2001 From: Christian Knell Date: Thu, 19 Dec 2024 14:30:09 +0100 Subject: [PATCH] fixed markdownlint and pre-commit-config --- .github/config/markdownlint.yaml | 258 +++++++++++++++++- .pre-commit-config.yaml | 4 +- charts/argocd-metrics-server/Chart.yaml | 4 +- charts/argocd-metrics-server/README.md | 2 +- charts/argocd-metrics-server/README.md.gotmpl | 2 +- charts/kubedoom/README.md | 4 +- charts/kubedoom/README.md.gotmpl | 4 +- charts/kutt/Chart.yaml | 4 +- charts/kutt/README.md | 37 +-- charts/kutt/README.md.gotmpl | 37 +-- charts/maildev/Chart.yaml | 4 +- charts/maildev/README.md | 11 +- charts/maildev/README.md.gotmpl | 11 +- charts/proxyweb/Chart.yaml | 2 +- charts/proxyweb/README.md | 22 +- charts/proxyweb/values.yaml | 2 + development/README.md | 31 ++- 17 files changed, 340 insertions(+), 99 deletions(-) diff --git a/.github/config/markdownlint.yaml b/.github/config/markdownlint.yaml index 5fa40c3a..e46b2665 100644 --- a/.github/config/markdownlint.yaml +++ b/.github/config/markdownlint.yaml @@ -1 +1,257 @@ -rules "~MD013", "~MD014", "~MD033", "~MD026" +# Example markdownlint configuration with all properties set to their default value + +# Default state for all rules +default: true + +# Path to configuration file to extend +extends: null + +# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md001.md +MD001: true + +# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md003.md +MD003: + # Heading style + style: "consistent" + +# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md004.md +MD004: + # List style + style: "consistent" + +# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md005.md +MD005: true + +# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md007.md +MD007: + # Spaces for indent + indent: 2 + # Whether to indent the first level of the list + start_indented: false + # Spaces for first level indent (when start_indented is set) + start_indent: 2 + +# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md009.md +MD009: + # Spaces for line break + br_spaces: 2 + # Allow spaces for empty lines in list items + list_item_empty_lines: false + # Include unnecessary breaks + strict: false + +# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md010.md +MD010: + # Include code blocks + code_blocks: true + # Fenced code languages to ignore + ignore_code_languages: [] + # Number of spaces for each hard tab + spaces_per_tab: 1 + +# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md011.md +MD011: true + +# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md012.md +MD012: + # Consecutive blank lines + maximum: 1 + +# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md013.md +MD013: false + +# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md014.md +MD014: true + +# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md018.md +MD018: true + +# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md019.md +MD019: true + +# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md020.md +MD020: true + +# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md021.md +MD021: true + +# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md022.md +MD022: + # Blank lines above heading + lines_above: 1 + # Blank lines below heading + lines_below: 1 + +# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md023.md +MD023: true + +# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md024.md +MD024: + # Only check sibling headings + siblings_only: false + +# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md025.md +MD025: + # Heading level + level: 1 + # RegExp for matching title in front matter + front_matter_title: "^\\s*title\\s*[:=]" + +# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md026.md +MD026: + # Punctuation characters + punctuation: ".,:!。，；：！" + +# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md027.md +MD027: true + +# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md028.md +MD028: true + +# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md029.md +MD029: + # List style + style: "one_or_ordered" + +# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md030.md +MD030: + # Spaces for single-line unordered list items + ul_single: 1 + # Spaces for single-line ordered list items + ol_single: 1 + # Spaces for multi-line unordered list items + ul_multi: 1 + # Spaces for multi-line ordered list items + ol_multi: 1 + +# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md031.md +MD031: + # Include list items + list_items: true + +# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md032.md +MD032: true + +# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md033.md +MD033: + # Allowed elements + allowed_elements: [] + +# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md034.md +MD034: false + +# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md035.md +MD035: + # Horizontal rule style + style: "consistent" + +# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md036.md +MD036: + # Punctuation characters + punctuation: ".,;:!?。，；：！？" + +# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md037.md +MD037: true + +# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md038.md +MD038: true + +# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md039.md +MD039: true + +# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md040.md +MD040: + # List of languages + allowed_languages: [] + # Require language only + language_only: false + +# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md041.md +MD041: + # Heading level + level: 1 + # RegExp for matching title in front matter + front_matter_title: "^\\s*title\\s*[:=]" + +# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md042.md +MD042: true + +# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md043.md +MD043: false + +# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md044.md +MD044: + # List of proper names + names: [] + # Include code blocks + code_blocks: true + # Include HTML elements + html_elements: true + +# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md045.md +MD045: true + +# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md046.md +MD046: + # Block style + style: "consistent" + +# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md047.md +MD047: true + +# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md048.md +MD048: + # Code fence style + style: "consistent" + +# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md049.md +MD049: + # Emphasis style + style: "consistent" + +# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md050.md +MD050: + # Strong style + style: "consistent" + +# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md051.md +MD051: + # Ignore case of fragments + ignore_case: false + +# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md052.md +MD052: + # Include shortcut syntax + shortcut_syntax: false + +# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md053.md +MD053: + # Ignored definitions + ignored_definitions: + - "//" + +# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md054.md +MD054: + # Allow autolinks + autolink: true + # Allow inline links and images + inline: true + # Allow full reference links and images + full: true + # Allow collapsed reference links and images + collapsed: true + # Allow shortcut reference links and images + shortcut: true + # Allow URLs as inline links + url_inline: true + +# MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md055.md +MD055: + # Table pipe style + style: "consistent" + +# MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md056.md +MD056: true + +# MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/doc/md058.md +MD058: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 527d7991..e819d0b7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -23,7 +23,9 @@ repos: - --chart-search-root=charts - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.32.2 + rev: v0.43.0 hooks: - id: markdownlint name: Markdownlint + args: [--config=.github/config/markdownlint.yaml] + language_version: lts diff --git a/charts/argocd-metrics-server/Chart.yaml b/charts/argocd-metrics-server/Chart.yaml index 4b61f42d..b11e6f0e 100644 --- a/charts/argocd-metrics-server/Chart.yaml +++ b/charts/argocd-metrics-server/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: argocd-metrics-server description: A Helm chart for installing the Argo CD Metrics Server, which connects to Prometheus and can be used to display Metrics in the Argo CD UI type: application -version: 1.0.1 +version: 1.0.2 appVersion: "v1.0.3" home: https://github.com/christianhuth/helm-charts icon: https://icon.icepanel.io/Technology/svg/Argo-CD.svg @@ -14,7 +14,7 @@ sources: annotations: artifacthub.io/changes: | - kind: added - description: attribute (prometheus.dashboards) for specifying your own dashboards + description: format README artifacthub.io/signKey: | fingerprint: EE24F8BB6D099E78FD704F83B5ECDBCDDD485D0E url: https://charts.christianhuth.de/public.key diff --git a/charts/argocd-metrics-server/README.md b/charts/argocd-metrics-server/README.md index 4da9b182..a4e2755e 100644 --- a/charts/argocd-metrics-server/README.md +++ b/charts/argocd-metrics-server/README.md @@ -93,7 +93,7 @@ Alternatively, a YAML file that specifies the values for the parameters can be p helm install my-release -f values.yaml christianhuth/argocd-metrics-server ``` -# Configuring Argo CD +## Configuring Argo CD After a successful installation of the Argo CD Metrics Server you need to configure Argo CD to display Metrics in the UI. diff --git a/charts/argocd-metrics-server/README.md.gotmpl b/charts/argocd-metrics-server/README.md.gotmpl index 530d9b87..532d7c58 100644 --- a/charts/argocd-metrics-server/README.md.gotmpl +++ b/charts/argocd-metrics-server/README.md.gotmpl @@ -53,7 +53,7 @@ Alternatively, a YAML file that specifies the values for the parameters can be p helm install my-release -f values.yaml christianhuth/argocd-metrics-server ``` -# Configuring Argo CD +## Configuring Argo CD After a successful installation of the Argo CD Metrics Server you need to configure Argo CD to display Metrics in the UI. diff --git a/charts/kubedoom/README.md b/charts/kubedoom/README.md index 68ac2937..167b6a8f 100644 --- a/charts/kubedoom/README.md +++ b/charts/kubedoom/README.md @@ -12,8 +12,6 @@ helm install my-release christianhuth/kubedoom ## Introduction - - This chart bootstraps [Kubedoom](https://github.com/storax/kubedoom) on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites @@ -38,7 +36,7 @@ These commands deploy Kubedoom on the Kubernetes cluster in the default configur Once everything is up and running inside your cluster, you will need to port forward by getting the pod and running kubectl port-forward. -``` +```console $ kubectl get pods -n kubedoom NAME READY STATUS RESTARTS AGE kubedoom-kubedoom-chart-676bcc5c9c-xkwpp 1/1 Running 0 2m29s diff --git a/charts/kubedoom/README.md.gotmpl b/charts/kubedoom/README.md.gotmpl index f0ce0c74..0cac2a69 100644 --- a/charts/kubedoom/README.md.gotmpl +++ b/charts/kubedoom/README.md.gotmpl @@ -11,8 +11,6 @@ helm install my-release christianhuth/kubedoom ## Introduction - - This chart bootstraps [Kubedoom](https://github.com/storax/kubedoom) on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites @@ -37,7 +35,7 @@ These commands deploy Kubedoom on the Kubernetes cluster in the default configur Once everything is up and running inside your cluster, you will need to port forward by getting the pod and running kubectl port-forward. -``` +```console $ kubectl get pods -n kubedoom NAME READY STATUS RESTARTS AGE kubedoom-kubedoom-chart-676bcc5c9c-xkwpp 1/1 Running 0 2m29s diff --git a/charts/kutt/Chart.yaml b/charts/kutt/Chart.yaml index 29b3d420..71b64572 100644 --- a/charts/kutt/Chart.yaml +++ b/charts/kutt/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: kutt description: Kutt is a free modern URL shortener. type: application -version: 4.2.3 +version: 4.2.4 appVersion: "v2.7.4" home: https://github.com/christianhuth/helm-charts icon: https://www.saashub.com/images/app/service_logos/15/d634f2359578/large.png @@ -23,7 +23,7 @@ dependencies: annotations: artifacthub.io/changes: | - kind: changed - description: added support for stable autoscaling api + description: format README artifacthub.io/screenshots: | - title: Simply shorten your link using the Web UI. url: https://d4.alternativeto.net/v9sHosD3RiPblfBOOHZi0gwU1M0pRL6Jn53oiobJi9k/rs:fit:1200:1200:0/g:ce:0:0/YWJzOi8vZGlzdC9zL2t1dHQtaXRfNzY3MjMzX2Z1bGwucG5n.jpg diff --git a/charts/kutt/README.md b/charts/kutt/README.md index 67d385db..c86bb813 100644 --- a/charts/kutt/README.md +++ b/charts/kutt/README.md @@ -147,24 +147,25 @@ This major updates the redis subchart to its newest major, 18.0.4. [Here](https: ### 2.0.0 This major updates the way you define environment variables. - - The section `mail` has been moved to `kutt.mail` - - The section `envSecrets` has been merged into `kutt`: - - `envSecrets.google` is now `kutt.google` - - `envSecrets.jwt` is now `kutt.jwt` - - `envSecrets.recaptcha` is now `kutt.recaptcha` - - The section `env` has been replaced with specific values: - - `ADMIN_EMAILS` is now `kutt.admin.emails` - - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` - - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` - - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` - - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` - - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` - - `LINK_LENGTH` is now `kutt.config.linkLength` - - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` - - `REPORT_EMAIL` is now `kutt.mail.reportEmail` - - `SITE_NAME` is now `kutt.config.siteName` - - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` - - You can define additional environment variables using the extraEnv section. + +- The section `mail` has been moved to `kutt.mail` +- The section `envSecrets` has been merged into `kutt`: + - `envSecrets.google` is now `kutt.google` + - `envSecrets.jwt` is now `kutt.jwt` + - `envSecrets.recaptcha` is now `kutt.recaptcha` +- The section `env` has been replaced with specific values: + - `ADMIN_EMAILS` is now `kutt.admin.emails` + - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` + - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` + - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` + - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` + - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` + - `LINK_LENGTH` is now `kutt.config.linkLength` + - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` + - `REPORT_EMAIL` is now `kutt.mail.reportEmail` + - `SITE_NAME` is now `kutt.config.siteName` + - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` +- You can define additional environment variables using the extraEnv section. ### 1.0.0 diff --git a/charts/kutt/README.md.gotmpl b/charts/kutt/README.md.gotmpl index 8b09728c..be210cc7 100644 --- a/charts/kutt/README.md.gotmpl +++ b/charts/kutt/README.md.gotmpl @@ -64,24 +64,25 @@ This major updates the redis subchart to its newest major, 18.0.4. [Here](https: ### 2.0.0 This major updates the way you define environment variables. - - The section `mail` has been moved to `kutt.mail` - - The section `envSecrets` has been merged into `kutt`: - - `envSecrets.google` is now `kutt.google` - - `envSecrets.jwt` is now `kutt.jwt` - - `envSecrets.recaptcha` is now `kutt.recaptcha` - - The section `env` has been replaced with specific values: - - `ADMIN_EMAILS` is now `kutt.admin.emails` - - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` - - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` - - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` - - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` - - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` - - `LINK_LENGTH` is now `kutt.config.linkLength` - - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` - - `REPORT_EMAIL` is now `kutt.mail.reportEmail` - - `SITE_NAME` is now `kutt.config.siteName` - - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` - - You can define additional environment variables using the extraEnv section. + +- The section `mail` has been moved to `kutt.mail` +- The section `envSecrets` has been merged into `kutt`: + - `envSecrets.google` is now `kutt.google` + - `envSecrets.jwt` is now `kutt.jwt` + - `envSecrets.recaptcha` is now `kutt.recaptcha` +- The section `env` has been replaced with specific values: + - `ADMIN_EMAILS` is now `kutt.admin.emails` + - `CUSTOM_DOMAIN_USE_HTTPS` is now `kutt.domain.customDomainUseHttps` + - `DEFAULT_DOMAIN` is now `kutt.domain.defaultDomain` + - `DEFAULT_MAX_STATS_PER_LINK` is now `kutt.config.defaultMaxStatsPerLink` + - `DISALLOW_ANONYMOUS_LINKS` is now `kutt.config.disallowAnonymousLinks` + - `DISALLOW_REGISTRATION` is now `kutt.config.disallowRegistration` + - `LINK_LENGTH` is now `kutt.config.linkLength` + - `NON_USER_COOLDOWN` is now `kutt.config.nonUserCooldown` + - `REPORT_EMAIL` is now `kutt.mail.reportEmail` + - `SITE_NAME` is now `kutt.config.siteName` + - `USER_LIMIT_PER_DAY` is now `kutt.config.userLimitPerDay` +- You can define additional environment variables using the extraEnv section. ### 1.0.0 diff --git a/charts/maildev/Chart.yaml b/charts/maildev/Chart.yaml index 1f343a88..aacaa0b3 100644 --- a/charts/maildev/Chart.yaml +++ b/charts/maildev/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: maildev description: MailDev is a simple way to test your emails during development with an easy to use web interface. type: application -version: 1.2.4 +version: 1.2.5 appVersion: "2.1.0" home: https://github.com/christianhuth/helm-charts icon: https://avatars1.githubusercontent.com/u/26743469 @@ -16,7 +16,7 @@ sources: annotations: artifacthub.io/changes: | - kind: changed - description: added support for stable autoscaling api + description: format README artifacthub.io/screenshots: | - title: SMTP server & web interface for viewing and testing emails during development. url: https://maildev.github.io/maildev/assets/img/original/maildev-light.png diff --git a/charts/maildev/README.md b/charts/maildev/README.md index 01eee708..24b6df9f 100644 --- a/charts/maildev/README.md +++ b/charts/maildev/README.md @@ -45,12 +45,13 @@ These commands deploy MailDev on the Kubernetes cluster in the default configura Forward your local port to the pod (this will block your terminal, open an additional one). -```bash +```console kubectl port-forward $(kubectl get pod -l "app.kubernetes.io/name=maildev" -o name) 1025 ``` Create dummy mail.txt file. -```bash + +```console cat <> mail.txt From: Test Maildev To: Nikola Tesla Tudela @@ -65,7 +66,7 @@ EOF Send the mail with curl: -```bash +```console curl smtp://localhost:1025 --mail-from test@maildev.com --mail-rcpt niko@tesla.com --upload-file ./mail.txt ``` @@ -73,13 +74,13 @@ The mail should now show up in your inbox. If you have enabled the logs for mails using `maildev.config.logMailContents=true`, you can also check the logs and see if the mail has been delivered. -```bash +```console kubectl logs $(kubectl get pod -l "app.kubernetes.io/name=maildev" -o name) ``` Output should be something like: -```bash +```console MailDev webapp running at http://0.0.0.0:1080 MailDev SMTP Server running at 0.0.0.0:1025 Received the following mail contents. diff --git a/charts/maildev/README.md.gotmpl b/charts/maildev/README.md.gotmpl index 8d1c6ab0..d6a09d01 100644 --- a/charts/maildev/README.md.gotmpl +++ b/charts/maildev/README.md.gotmpl @@ -45,12 +45,13 @@ These commands deploy MailDev on the Kubernetes cluster in the default configura Forward your local port to the pod (this will block your terminal, open an additional one). -```bash +```console kubectl port-forward $(kubectl get pod -l "app.kubernetes.io/name=maildev" -o name) 1025 ``` Create dummy mail.txt file. -```bash + +```console cat <> mail.txt From: Test Maildev To: Nikola Tesla Tudela @@ -65,7 +66,7 @@ EOF Send the mail with curl: -```bash +```console curl smtp://localhost:1025 --mail-from test@maildev.com --mail-rcpt niko@tesla.com --upload-file ./mail.txt ``` @@ -73,13 +74,13 @@ The mail should now show up in your inbox. If you have enabled the logs for mails using `maildev.config.logMailContents=true`, you can also check the logs and see if the mail has been delivered. -```bash +```console kubectl logs $(kubectl get pod -l "app.kubernetes.io/name=maildev" -o name) ``` Output should be something like: -```bash +```console MailDev webapp running at http://0.0.0.0:1080 MailDev SMTP Server running at 0.0.0.0:1025 Received the following mail contents. diff --git a/charts/proxyweb/Chart.yaml b/charts/proxyweb/Chart.yaml index e95178b5..1a646bdf 100644 --- a/charts/proxyweb/Chart.yaml +++ b/charts/proxyweb/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: proxyweb description: A Helm chart for Kubernetes type: application -version: 1.0.4 +version: 1.0.5 appVersion: "latest" home: https://github.com/christianhuth/helm-charts maintainers: [] diff --git a/charts/proxyweb/README.md b/charts/proxyweb/README.md index c65be468..3f55301e 100644 --- a/charts/proxyweb/README.md +++ b/charts/proxyweb/README.md @@ -57,27 +57,7 @@ The command removes all the Kubernetes components associated with the chart and | configuration.config.global.default_server | string | `"proxysql"` | | | configuration.config.global.hide_tables[0] | string | `""` | | | configuration.config.global.read_only | bool | `false` | | -| configuration.config.misc.adhoc_report[0].info | string | `"Examining queries with big sum_time(number of execution * time to run) is a good place to start when optimizing queries."` | | -| configuration.config.misc.adhoc_report[0].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time/1000/1000 as sum_time_sec FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY sum_time DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[0].title | string | `"Top 10 SELECTs by sum_time"` | | -| configuration.config.misc.adhoc_report[1].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | -| configuration.config.misc.adhoc_report[1].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY count_star DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[1].title | string | `"Top 10 SELECTs by count_star"` | | -| configuration.config.misc.adhoc_report[2].info | string | `"Caching/rewriting/even removing frequently running queries can improve the overall performance significantly. ProxySQL support all the mentioned methods. Example: it's a good idea to cache queries often issued by connectors like `^SELECT @@max_allowed_packet`"` | | -| configuration.config.misc.adhoc_report[2].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time, (sum_time/count_star)/1000 as avg_time_ms FROM stats_mysql_query_digest WHERE digest_text LIKE 'SELECT%' ORDER BY avg_time_ms DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[2].title | string | `"Top 10 SELECTs by avg_time"` | | -| configuration.config.misc.adhoc_report[3].info | string | `"This helps identify the most frequently running writes"` | | -| configuration.config.misc.adhoc_report[3].sql | string | `"SELECT digest,username,schemaname, SUBSTR(digest_text,0,80),count_star,sum_time FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' order by count_star DESC LIMIT 10;"` | | -| configuration.config.misc.adhoc_report[3].title | string | `"Top 10 writes"` | | -| configuration.config.misc.adhoc_report[4].info | string | `"This helps identify the schemas getting the most writes"` | | -| configuration.config.misc.adhoc_report[4].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent, sum(count_star) as sum_count_star FROM stats_mysql_query_digest where digest_text LIKE 'INSERT%' or digest_text like 'DELETE%' or digest_text like 'UPDATE%' group by schemaname order by time_spent desc;"` | | -| configuration.config.misc.adhoc_report[4].title | string | `"Schemas with the most DMLs"` | | -| configuration.config.misc.adhoc_report[5].info | string | `"List of the schemas with the highest overall sum_time"` | | -| configuration.config.misc.adhoc_report[5].sql | string | `"SELECT schemaname, sum(sum_time) as time_spent FROM stats_mysql_query_digest group by schemaname order by time_spent desc limit 5;"` | | -| configuration.config.misc.adhoc_report[5].title | string | `"Top 5 schemas by sum_time"` | | -| configuration.config.misc.adhoc_report[6].info | string | `"Don't send selects to the readers without checking the impact first as the app might read back the data immediately after writing it."` | | -| configuration.config.misc.adhoc_report[6].sql | string | `"select \"replace into mysql_query_rules (username,schemaname,destination_hostgroup,active,apply,digest) values('\" || st.username || \"','\" || st.schemaname || \"',12,1,1,'\" || st.digest || \"');\" from stats_mysql_query_digest st left join runtime_mysql_query_rules qr on st.digest = qr.digest where qr.rule_id is null and digest_text LIKE 'SELECT%' ORDER BY count_star desc limit 5;"` | | -| configuration.config.misc.adhoc_report[6].title | string | `"Send the top 5 SELECTS to the readers"` | | +| configuration.config.misc.adhoc_report | list | see [values.yaml](./values.yaml) | List of reports that should be displayed | | configuration.config.servers.proxysql.dsn[0].db | string | `"main"` | | | configuration.config.servers.proxysql.dsn[0].host | string | `"127.0.0.1"` | | | configuration.config.servers.proxysql.dsn[0].passwd | string | `"sadmin"` | | diff --git a/charts/proxyweb/values.yaml b/charts/proxyweb/values.yaml index efdd89c5..968c8eb8 100644 --- a/charts/proxyweb/values.yaml +++ b/charts/proxyweb/values.yaml @@ -111,6 +111,8 @@ configuration: default_server: "proxysql" read_only: false misc: + # -- List of reports that should be displayed + # @default -- see [values.yaml](./values.yaml) adhoc_report: - {"title": "Top 10 SELECTs by sum_time", "info": "Examining queries with big sum_time(number of execution * time to run) is a good place to start when optimizing queries.", diff --git a/development/README.md b/development/README.md index 1df7298c..5634f799 100644 --- a/development/README.md +++ b/development/README.md @@ -1,22 +1,22 @@ -## Development +# Development -### Development Environment Setup +## Development Environment Setup 1. (Optional) Install the [pre-commit](https://pre-commit.com/) hooks - ```sh - pip3 install pre-commit - pre-commit install - ``` + ```console + pip3 install pre-commit + pre-commit install --install-hooks + ``` -1. (Optional) Setup a KinD cluster with Nginx ingress support +1. (Optional) Setup a minikube cluster with Nginx ingress support - ```sh - kind create cluster --config=development/kind-with-ingress-support.yaml - kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml - ``` + ```console + minikube start --addons=ingress --cpus=4 --memory=8g --profile=helm-charts-development + minikube profile helm-charts-development + ``` -### Development Process +## Development Process 1. Make changes to the charts @@ -26,12 +26,13 @@ 1. Update the README.md (execute in the root folder of the chart you changed): - ```sh - docker run --rm -v $PWD/../..:/root/workspace ghcr.io/chgl/kube-powertools:latest generate-docs.sh + ```console + docker run --rm -v $PWD/../..:/root/workspace ghcr.io/chgl/kube-powertools:latest helm-docs --chart-search-root=charts ``` 1. Update values.schema.json (requires a [Helm-Plugin](https://github.com/karuppiah7890/helm-schema-gen)): - ``` + + ```console helm schema-gen values.yaml > values.schema.json ```