github.com/microsoft/fabrikate@v1.0.0-alpha.1.0.20210115014322-dc09194d0885/testdata/generate-yaml/helm_repos/grafana/README.md (about)

     1  # Helm Charts
     2  
     3  Use this repository to submit official Charts for Helm. Charts are curated application definitions for Helm. For more information about installing and using Helm, see its
     4  [README.md](https://github.com/helm/helm/tree/master/README.md). To get a quick introduction to Charts see this [chart document](https://github.com/helm/helm/blob/master/docs/charts.md).
     5  
     6  ## Where to find us
     7  
     8  For general Helm Chart discussions join the Helm Charts (#charts) room in the [Kubernetes](http://slack.kubernetes.io/).
     9  
    10  For issues and support for Helm and Charts see [Support Channels](CONTRIBUTING.md#support-channels).
    11  
    12  ## How do I install these charts?
    13  
    14  Just `helm install stable/<chart>`. This is the default repository for Helm which is located at https://kubernetes-charts.storage.googleapis.com/ and is installed by default.
    15  
    16  For more information on using Helm, refer to the [Helm's documentation](https://github.com/kubernetes/helm#docs).
    17  
    18  ## How do I enable the Incubator repository?
    19  
    20  To add the Incubator charts for your local client, run `helm repo add`:
    21  
    22  ```
    23  $ helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
    24  "incubator" has been added to your repositories
    25  ```
    26  
    27  You can then run `helm search incubator` to see the charts.
    28  
    29  ## Chart Format
    30  
    31  Take a look at the [alpine example chart](https://github.com/helm/helm/tree/master/docs/examples/alpine) and the [nginx example chart](https://github.com/helm/helm/tree/master/docs/examples/nginx) for reference when you're writing your first few charts.
    32  
    33  Before contributing a Chart, become familiar with the format. Note that the project is still under active development and the format may still evolve a bit.
    34  
    35  ## Repository Structure
    36  
    37  This GitHub repository contains the source for the packaged and versioned charts released in the [`gs://kubernetes-charts` Google Storage bucket](https://console.cloud.google.com/storage/browser/kubernetes-charts/) (the Chart Repository).
    38  
    39  The Charts in the `stable/` directory in the master branch of this repository match the latest packaged Chart in the Chart Repository, though there may be previous versions of a Chart available in that Chart Repository.
    40  
    41  The purpose of this repository is to provide a place for maintaining and contributing official Charts, with CI processes in place for managing the releasing of Charts into the Chart Repository.
    42  
    43  The Charts in this repository are organized into two folders:
    44  
    45  * stable
    46  * incubator
    47  
    48  Stable Charts meet the criteria in the [technical requirements](CONTRIBUTING.md#technical-requirements).
    49  
    50  Incubator Charts are those that do not meet these criteria. Having the incubator folder allows charts to be shared and improved on until they are ready to be moved into the stable folder. The charts in the `incubator/` directory can be found in the [`gs://kubernetes-charts-incubator` Google Storage Bucket](https://console.cloud.google.com/storage/browser/kubernetes-charts-incubator).
    51  
    52  In order to get a Chart from incubator to stable, Chart maintainers should open a pull request that moves the chart folder.
    53  
    54  ## Contributing a Chart
    55  
    56  We'd love for you to contribute a Chart that provides a useful application or service for Kubernetes. Please read our [Contribution Guide](CONTRIBUTING.md) for more information on how you can contribute Charts.
    57  
    58  Note: We use the same [workflow](https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#workflow),
    59  [License](LICENSE) and [Contributor License Agreement](CONTRIBUTING.md) as the main Kubernetes repository.
    60  
    61  ## Owning and Maintaining A Chart
    62  
    63  Individual charts can be maintained by one or more users of GitHub. When someone maintains a chart they have the access to merge changes to that chart. To have merge access to a chart someone needs to:
    64  
    65  1. Be listed on the chart, in the `Chart.yaml` file, as a maintainer. If you need sponsors and have contributed to the chart, please reach out to the existing maintainers, or if you are having trouble connecting with them, please reach out to one of the [OWNERS](OWNERS) of the charts repository.
    66  1. Be invited (and accept your invite) as a read-only collaborator on [this repo](https://github.com/helm/charts). This is required for @k8s-ci-robot [PR comment interaction](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md).
    67  1. An OWNERS file needs to be added to a chart. That OWNERS file should list the maintainers' GitHub login names for both the reviewers and approvers sections. For an example see the [Drupal chart](stable/drupal/OWNERS). The `OWNERS` file should also be appended to the `.helmignore` file.
    68  
    69  Once these three steps are done a chart approver can merge pull requests following the directions in the [REVIEW_GUIDELINES.md](REVIEW_GUIDELINES.md) file.
    70  
    71  ## Trusted Collaborator
    72  
    73  The `pull-charts-e2e` test run, that installs a chart to test it, is required before a pull request can be merged. These tests run automatically for members of the Helm Org and for chart [repository collaborators](https://help.github.com/articles/adding-outside-collaborators-to-repositories-in-your-organization/). For regular contributors who are trusted, in a manner similar to Kubernetes community members, we have trusted collaborators. These individuals can have their tests run automatically as well as mark other pull requests as ok to test by adding a comment of `/ok-to-test` on pull requests.
    74  
    75  There are two paths to becoming a trusted collaborator. One only needs follow one of them.
    76  
    77  1. If you are a Kubernetes GitHub org member and have your Kubernetes org membership public you can become a trusted collaborator for Helm Charts
    78  2. Get sponsorship from one of the Charts Maintainers listed in the OWNERS file at the root of this repository
    79  
    80  The process to get added is:
    81  
    82  * File an issue asking to be a trusted collaborator
    83  * A Helm Chart Maintainer can then add the user as a read only collaborator to the repository
    84  
    85  ## Review Process
    86  
    87  For information related to the review procedure used by the Chart repository maintainers, see [Merge approval and release process](CONTRIBUTING.md#merge-approval-and-release-process).
    88  
    89  ### Stale Pull Requests and Issues
    90  
    91  Pull Requests and Issues that have no activity for 30 days automatically become stale. After 30 days of being stale, without activity, they become rotten. Pull Requests and Issues can rot for 30 days and then they are automatically closed. This is the standard stale process handling for all repositories on the Kubernetes GitHub organization.
    92  
    93  ## Supported Kubernetes Versions
    94  
    95  This chart repository supports the latest and previous minor versions of Kubernetes. For example, if the latest minor release of Kubernetes is 1.8 then 1.7 and 1.8 are supported. Charts may still work on previous versions of Kubernertes even though they are outside the target supported window.
    96  
    97  To provide that support the API versions of objects should be those that work for both the latest minor release and the previous one.
    98  
    99  ## Status of the Project
   100  
   101  This project is still under active development, so you might run into [issues](https://github.com/helm/charts/issues). If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature.