Merge pull request #678 from HubertStefanski/https-proxy

feat: add HTTPSProxy to env var
grafana · Feb 22, 2022 · 97f526b · 97f526b
2 parents ad25aae + 6c31f48
commit 97f526b
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 2 deletions.
diff --git a/api/integreatly/v1alpha1/grafana_types.go b/api/integreatly/v1alpha1/grafana_types.go
@@ -123,8 +123,9 @@ type GrafanaDeployment struct {
 // GrafanaHttpProxy provides a means to configure the Grafana deployment
 // to use an HTTP(S) proxy when making requests and resolving plugins.
 type GrafanaHttpProxy struct {
-	Enabled bool   `json:"enabled"`
-	URL     string `json:"url,omitempty"`
+	Enabled   bool   `json:"enabled"`
+	URL       string `json:"url,omitempty"`
+	SecureURL string `json:"secureUrl,omitempty"`
 }
 
 // GrafanaIngress provides a means to configure the ingress created

diff --git a/config/crd/bases/integreatly.org_grafanas.yaml b/config/crd/bases/integreatly.org_grafanas.yaml
@@ -4404,6 +4404,8 @@ spec:
                     properties:
                       enabled:
                         type: boolean
+                      secureUrl:
+                        type: string
                       url:
                         type: string
                     required:

diff --git a/controllers/model/grafanaDeployment.go b/controllers/model/grafanaDeployment.go
@@ -552,6 +552,12 @@ func getContainers(cr *v1alpha1.Grafana, configHash, dsHash string) []v13.Contai
 			Name:  "HTTP_PROXY",
 			Value: cr.Spec.Deployment.HttpProxy.URL,
 		})
+		if cr.Spec.Deployment.HttpProxy.SecureURL != "" {
+			envVars = append(envVars, v13.EnvVar{
+				Name:  "HTTPS_PROXY",
+				Value: cr.Spec.Deployment.HttpProxy.SecureURL,
+			})
+		}
 	}
 
 	if cr.Spec.Deployment != nil && cr.Spec.Deployment.Env != nil {
@@ -642,6 +648,12 @@ func getInitContainers(cr *v1alpha1.Grafana, plugins string) []v13.Container {
 			Name:  "HTTP_PROXY",
 			Value: cr.Spec.Deployment.HttpProxy.URL,
 		})
+		if cr.Spec.Deployment.HttpProxy.SecureURL != "" {
+			envVars = append(envVars, v13.EnvVar{
+				Name:  "HTTPS_PROXY",
+				Value: cr.Spec.Deployment.HttpProxy.SecureURL,
+			})
+		}
 	}
 
 	var volumeName = constants.GrafanaPluginsVolumeName

diff --git a/deploy/manifests/latest/crds.yaml b/deploy/manifests/latest/crds.yaml
@@ -4981,6 +4981,8 @@ spec:
                     properties:
                       enabled:
                         type: boolean
+                      secureUrl:
+                        type: string
                       url:
                         type: string
                     required:

diff --git a/documentation/api.md b/documentation/api.md
@@ -11700,6 +11700,13 @@ GrafanaHttpProxy provides a means to configure the Grafana deployment to use an
           <br/>
         </td>
         <td>true</td>
+      </tr><tr>
+        <td><b>secureUrl</b></td>
+        <td>string</td>
+        <td>
+          <br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>url</b></td>
         <td>string</td>

diff --git a/documentation/plugins.md b/documentation/plugins.md
@@ -36,3 +36,19 @@ stringData:
 ```
 
 If the plugin doesn't install, try restarting the grafana deployment.
+
+## Install plugins through a HTTP(S) Proxy
+
+To install plugins through a HTTP(S) Proxy, you will have to define the `spec.deployment.HttpProxy` section of the Grafana CR. EG:
+
+If you need to use HTTPS, please add your HTTPS proxy URL to the `secureURL` section.
+
+```yaml
+spec:
+  ...
+  deployment:
+    HttpProxy:
+      enabled: true
+      url: <your proxy URL here>
+      secureURL: <your HTTPS proxy URL here>
+```