sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/plugins/optional/grafana/v1alpha/constants.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package v1alpha
    18  
    19  // nolint: lll
    20  const MetaDataDescription = `This command will add Grafana manifests to the project:
    21    - A JSON file includes dashboard manifest that can be directly copied to Grafana Web UI.
    22  	('grafana/controller-runtime-metrics.json')
    23  
    24  NOTE: This plugin requires:
    25  - Access to Prometheus
    26  - Your project must be using controller-runtime to expose the metrics via the controller metrics and they need to be collected by Prometheus.
    27  - Access to Grafana (https://grafana.com/docs/grafana/latest/setup-grafana/installation/)
    28  Check how to enable the metrics for your project by looking at the doc: https://book.kubebuilder.io/reference/metrics.html
    29  `