cdk8s-team / cdk8s-grafana Goto Github PK

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

What happened:

Tried adding a dashboard to grafana in Python using:

        grafana.add_dashboard("k8sDashBoard",
                              title="Kubernetes Metrics",
                              json_model=k8s_dashboard,
                              data_source_variables={"DS_PROMETHEUS": "prometheus.name"}
                              )

Expected:

The dashboard gets added to Grafana

Result:

cdk8s synth worked fine and generated the Yaml. However on kubectl apply, K8s threw the error:

error: error validating "dist/GrafanaDashboard.grafana-k8sdashboard-c8f7fb82.k8s.yaml": error validating data: ValidationError(GrafanaDashboard.spec): unknown field "name" in org.integreatly.v1alpha1.GrafanaDashboard.spec; if you choose to ignore these errors, turn validation off with --validate=false

Reason for Issue:

The generated manifest added a spec.name field which is not recognized but the validation. Synth is adding the id fo the dashboard as a name inside the spec. Partial yaml naivest below (for brevity):

apiVersion: integreatly.org/v1alpha1
kind: GrafanaDashboard
metadata:
  labels:
    app: grafana
  name: grafana-k8sdashboard2-c8bfb3a3
  namespace: my-grafana-operator
spec:
  datasources:
    - datasourceName: prometheus.name
      inputName: DS_PROMETHEUS
  json: <...>
  name: k8sDashBoard
  plugins: []

If the spec.name is commented out, the yaml can be deployed normally

cdk8s synth --version
1.0.57

How to fix it

Change required to operator in cdk8s-grafana/src/dashboard.ts

    new GrafanaDashboard(this, 'Resource', {
      metadata: {
        labels: props.labels,
        namespace: props.namespace,
      },
      spec: {
        customFolderName: props.folder,
        datasources: dataSources,
        plugins: this.plugins,
        json: JSON.stringify({
          ...defaults,
          ...props.jsonModel,
        }, null, 2),
        name: id,
      },
    });

Should be:

    new GrafanaDashboard(this, 'Resource', {
      metadata: {
        labels: props.labels,
        namespace: props.namespace,
      },
      spec: {
        customFolderName: props.folder,
        datasources: dataSources,
        plugins: this.plugins,
        json: JSON.stringify({
          ...defaults,
          ...props.jsonModel,
        }, null, 2),
      },
    });

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/12

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

The construct does not expose the service type and thus the end user cannot create a service of type NodePort to expose Grafana when using the construct.
Currently the only way to create a NodePort is to set the Ingress flag to false in the init and then add the following to the generated YAML:

  service:
    type: NodePort

Note that the underlying object exposes the service object, it just needs to be exposed in the construct as well.

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/11

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/14

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/8

Github reported a new dependabot security alert at: https://github.com/cdk8s-team/cdk8s-grafana/security/dependabot/9