[bitnami/charts] Apply linter to README files (#15357)

* Fix markdown linter issues in all markdown files present in this repo

Signed-off-by: Fran Mulero <fmulero@vmware.com>

* Apply markdown fixes

Signed-off-by: Fran Mulero <fmulero@vmware.com>

* Update README.md with readme-generator-for-helm

Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>

* Remove appsmith empty section

Signed-off-by: Fran Mulero <fmulero@vmware.com>

---------

Signed-off-by: Fran Mulero <fmulero@vmware.com>
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
Co-authored-by: Bitnami Containers <bitnami-bot@vmware.com>
This commit is contained in:
Fran Mulero
2023-03-07 10:49:14 +01:00
committed by GitHub
parent 956de76384
commit 0e29e600d3
108 changed files with 284 additions and 265 deletions

View File

@@ -88,48 +88,48 @@ The command removes all the Kubernetes components associated with the chart and
### SonarQube&trade; Configuration parameters
| Name | Description | Value |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `sonarqubeUsername` | SonarQube&trade; username | `user` |
| `sonarqubePassword` | SonarQube&trade; user password | `""` |
| `provisioningFolder` | Directory to use for provisioning content to Sonarqube | `/bitnami/sonarqube-provisioning` |
| `existingSecret` | Name of existing secret containing SonarQube&trade; credentials | `""` |
| `sonarqubeEmail` | SonarQube&trade; user email | `user@example.com` |
| `minHeapSize` | Minimum heap size for SonarQube&trade; | `1024m` |
| `maxHeapSize` | Maximum heap size for SonarQube&trade; | `2048m` |
| `jvmOpts` | Values to add to SONARQUBE_WEB_JVM_OPTS | `""` |
| `jvmCeOpts` | Values to add to SONAR_CE_JAVAOPTS | `""` |
| `startTimeout` | Timeout for the application to start in seconds | `150` |
| `extraProperties` | List of extra properties to be set in the sonar.properties file (key=value format) | `[]` |
| `sonarqubeSkipInstall` | Skip wizard installation | `false` |
| `sonarSecurityRealm` | Set this to LDAP authenticate first against the external sytem. If the external system is not | `""` |
| `sonarAuthenticatorDowncase` | Set to true when connecting to a LDAP server using a case-insensitive setup. | `""` |
| `ldap.url` | URL of the LDAP server. If you are using ldaps, you should install the server certificate into the Java truststore | `""` |
| `ldap.bindDn` | The username of an LDAP user to connect (or bind) with. Leave this blank for anonymous access to the LDAP directory. | `""` |
| `ldap.bindPassword` | The password of the user to connect with. Leave this blank for anonymous access to the LDAP directory. | `""` |
| `ldap.authentication` | Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html) | `simple` |
| `ldap.realm` | See Digest-MD5 Authentication, CRAM-MD5 Authentication (http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html) | `""` |
| `ldap.contextFactoryClass` | Context factory class. | `com.sun.jndi.ldap.LdapCtxFactory` |
| `ldap.StartTLS` | Enable use of StartTLS | `false` |
| `ldap.followReferrals` | Follow referrals or not | `true` |
| `ldap.user.baseDn` | Distinguished Name (DN) of the root node in LDAP from which to search for users. | `""` |
| `ldap.user.request` | LDAP user request. | `(&(objectClass=inetOrgPerson)(uid={login}))` |
| `ldap.user.realNameAttribute` | in LDAP defining the users real name. | `cn` |
| `ldap.user.emailAttribute` | Attribute in LDAP defining the users email. | `mail` |
| `ldap.group.baseDn` | Distinguished Name (DN) of the root node in LDAP from which to search for groups. | `""` |
| `ldap.group.request` | LDAP group request. | `(&(objectClass=groupOfUniqueNames)(uniqueMember={dn}))` |
| `ldap.group.idAttribute` | Attribute in LDAP defining the groups real name. | `cn` |
| `smtpHost` | SMTP server host | `""` |
| `smtpPort` | SMTP server port | `""` |
| `smtpUser` | SMTP username | `""` |
| `smtpPassword` | SMTP user password | `""` |
| `smtpProtocol` | SMTP protocol | `""` |
| `smtpExistingSecret` | The name of an existing secret with SMTP credentials | `""` |
| `command` | Override default container command (useful when using custom images) | `[]` |
| `args` | Override default container args (useful when using custom images) | `[]` |
| `extraEnvVars` | Array with extra environment variables to add to SonarQube&trade; nodes | `[]` |
| `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for SonarQube&trade; nodes | `""` |
| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars for SonarQube&trade; nodes | `""` |
| Name | Description | Value |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `sonarqubeUsername` | SonarQube&trade; username | `user` |
| `sonarqubePassword` | SonarQube&trade; user password | `""` |
| `provisioningFolder` | Directory to use for provisioning content to Sonarqube | `/bitnami/sonarqube-provisioning` |
| `existingSecret` | Name of existing secret containing SonarQube&trade; credentials | `""` |
| `sonarqubeEmail` | SonarQube&trade; user email | `user@example.com` |
| `minHeapSize` | Minimum heap size for SonarQube&trade; | `1024m` |
| `maxHeapSize` | Maximum heap size for SonarQube&trade; | `2048m` |
| `jvmOpts` | Values to add to SONARQUBE_WEB_JVM_OPTS | `""` |
| `jvmCeOpts` | Values to add to SONAR_CE_JAVAOPTS | `""` |
| `startTimeout` | Timeout for the application to start in seconds | `150` |
| `extraProperties` | List of extra properties to be set in the sonar.properties file (key=value format) | `[]` |
| `sonarqubeSkipInstall` | Skip wizard installation | `false` |
| `sonarSecurityRealm` | Set this to LDAP authenticate first against the external sytem. If the external system is not | `""` |
| `sonarAuthenticatorDowncase` | Set to true when connecting to a LDAP server using a case-insensitive setup. | `""` |
| `ldap.url` | URL of the LDAP server. If you are using ldaps, you should install the server certificate into the Java truststore | `""` |
| `ldap.bindDn` | The username of an LDAP user to connect (or bind) with. Leave this blank for anonymous access to the LDAP directory. | `""` |
| `ldap.bindPassword` | The password of the user to connect with. Leave this blank for anonymous access to the LDAP directory. | `""` |
| `ldap.authentication` | Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (<http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html>) | `simple` |
| `ldap.realm` | See Digest-MD5 Authentication, CRAM-MD5 Authentication (<http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html>) | `""` |
| `ldap.contextFactoryClass` | Context factory class. | `com.sun.jndi.ldap.LdapCtxFactory` |
| `ldap.StartTLS` | Enable use of StartTLS | `false` |
| `ldap.followReferrals` | Follow referrals or not | `true` |
| `ldap.user.baseDn` | Distinguished Name (DN) of the root node in LDAP from which to search for users. | `""` |
| `ldap.user.request` | LDAP user request. | `(&(objectClass=inetOrgPerson)(uid={login}))` |
| `ldap.user.realNameAttribute` | in LDAP defining the users real name. | `cn` |
| `ldap.user.emailAttribute` | Attribute in LDAP defining the users email. | `mail` |
| `ldap.group.baseDn` | Distinguished Name (DN) of the root node in LDAP from which to search for groups. | `""` |
| `ldap.group.request` | LDAP group request. | `(&(objectClass=groupOfUniqueNames)(uniqueMember={dn}))` |
| `ldap.group.idAttribute` | Attribute in LDAP defining the groups real name. | `cn` |
| `smtpHost` | SMTP server host | `""` |
| `smtpPort` | SMTP server port | `""` |
| `smtpUser` | SMTP username | `""` |
| `smtpPassword` | SMTP user password | `""` |
| `smtpProtocol` | SMTP protocol | `""` |
| `smtpExistingSecret` | The name of an existing secret with SMTP credentials | `""` |
| `command` | Override default container command (useful when using custom images) | `[]` |
| `args` | Override default container args (useful when using custom images) | `[]` |
| `extraEnvVars` | Array with extra environment variables to add to SonarQube&trade; nodes | `[]` |
| `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for SonarQube&trade; nodes | `""` |
| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars for SonarQube&trade; nodes | `""` |
### SonarQube&trade; deployment parameters
@@ -481,4 +481,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.

View File

@@ -159,10 +159,10 @@ ldap:
## @param ldap.bindPassword The password of the user to connect with. Leave this blank for anonymous access to the LDAP directory.
##
bindPassword: ""
## @param ldap.authentication Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html)
## @param ldap.authentication Possible values: simple, CRAM-MD5, DIGEST-MD5, GSSAPI. See the tutorial on authentication mechanisms (<http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html>)
##
authentication: simple
## @param ldap.realm See Digest-MD5 Authentication, CRAM-MD5 Authentication (http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html)
## @param ldap.realm See Digest-MD5 Authentication, CRAM-MD5 Authentication (<http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html>)
##
realm: ""
## @param ldap.contextFactoryClass Context factory class.