diff --git a/LICENSE b/LICENSE index 4a48c8e3c..1f04280ab 100644 --- a/LICENSE +++ b/LICENSE @@ -1,8 +1,5 @@ MIT License -Copyright for portions of this Project are held by Oteemo Inc, 2020. -All other copyright for this project are held by SonarSource S.A, 2021 - Copyright (c) 2021 SonarSource S.A. Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 205cf826b..e50b44c4b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -# About this Repo +SonarQube Helm Chart +================= -This is the Git repo of the official SonarSource Helm Chart for SonarQube. -The actual chart can be found, with additional information, in the [charts](charts/) directory. +About this Repo +---------------- + +This is the Git repo of the SonarSource Helm Chart for [SonarQube](https://www.sonarqube.org/). +The actual chart can be found in the [charts](charts/sonarqube) directory and see the README of the chart for more information. Have Question or Feedback? -------------------------- diff --git a/charts/sonarqube/CHANGELOG.md b/charts/sonarqube/CHANGELOG.md index 42f2f986e..abd60de40 100644 --- a/charts/sonarqube/CHANGELOG.md +++ b/charts/sonarqube/CHANGELOG.md @@ -9,7 +9,7 @@ All changes to this chart will be documented in this file. * updated application version to 8.8-community * improved readiness/startup and liveness probes * improved documentation -* made helm chart the official sonarsource chart for SonarQube + ## [0.9.6.2] * Change order of env variables to better support 7.9-lts diff --git a/charts/sonarqube/README.md b/charts/sonarqube/README.md index d18fc9780..a1fb7e176 100644 --- a/charts/sonarqube/README.md +++ b/charts/sonarqube/README.md @@ -6,6 +6,8 @@ This chart bootstraps a SonarQube instance with a PostgreSQL database. +Please note that this chart only supports SonarQube Community, Developer, and Enterprise Editions. + ## Compatibility | SonarQube Version | Kubernetes Version | Helm Chart Version | @@ -17,28 +19,21 @@ This chart bootstraps a SonarQube instance with a PostgreSQL database. To install the chart: ```bash -helm repo add sonarsource +git clone https://github.com/SonarSource/helm-chart-sonarqube.git +cd helm-chart-sonarqube +helm dependency update kubectl create namespace sonarqube -helm upgrade --install -n sonarqube sonarqube sonarsource/sonarqube +helm upgrade --install -f values.yaml -n sonarqube sonarqube ./ ``` The above command deploys Sonarqube on the Kubernetes cluster in the default configuration in the sonarqube namespace. The [configuration](#configuration) section lists the parameters that can be configured during installation. The default login is admin/admin. -### Install the chart without a chart repository - -To install Sonarqube without a chart repository, you need to clone this repository and reference this chart locally - -```bash -git clone https://github.com/SonarSource/helm-chart-sonarqube.git -cd helm-chart-sonarqube -helm dependency update -kubectl create namespace sonarqube -helm upgrade --install -f values.yaml -n sonarqube sonarqube ./ -``` +## How to use it -As the other methode this will install sonarqube on the Kubernetes cluster with the default configuration in the sonarqube namespace. +Take some time to read the Deploy on [SonarQube on Kubernetes](https://docs.sonarqube.org/latest/setup/sonarqube-on-kubernetes/) page. +SonarQube deployment on Kubernetes has been tested with the recommendations and constraints documented there, and deployment has some limitations. ## Uninstalling the chart