-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Helm Chart for Grafana Dashboard(s) #43
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Patterns to ignore when building packages. | ||
# This supports shell glob matching, relative path matching, and | ||
# negation (prefixed with !). Only one pattern per line. | ||
.DS_Store | ||
# Common VCS dirs | ||
.git/ | ||
.gitignore | ||
.bzr/ | ||
.bzrignore | ||
.hg/ | ||
.hgignore | ||
.svn/ | ||
# Common backup files | ||
*.swp | ||
*.bak | ||
*.tmp | ||
*.orig | ||
*~ | ||
# Various IDEs | ||
.project | ||
.idea/ | ||
*.tmproj | ||
.vscode/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Copyright © 2022 Kaleido, Inc. | ||
# | ||
# SPDX-License-Identifier: Apache-2.0 | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://swww.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
apiVersion: v2 | ||
name: firefly-grafana-dashboards | ||
description: A Helm chart to manage Grafana dashboards for monitoring FireFly Supernode installations. | ||
type: application | ||
version: 0.5.0 | ||
appVersion: "1.0.0" | ||
|
||
maintainers: | ||
- name: hfuss | ||
email: hayden.fuss@kaleido.io | ||
- name: drewmarshburn | ||
email: drew.marshburn@kaleido.io | ||
- name: peterbroadhurst | ||
email: peter.broadhurst@kaleido.io | ||
- name: calbritt | ||
email: cari.albritton@kaleido.io |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# FireFly Grafana Dashboards | ||
|
||
... | ||
|
||
### Table of Contents | ||
|
||
* [Prerequisites](#prerequisites) | ||
* [Get Repo Info](#get-repo-info) | ||
* [Install Chart](#install-chart) | ||
* [Uninstall Chart](#uninstall-chart) | ||
* [Upgrading Chart](#upgrading-chart) | ||
* [Using as a Dependency](#using-as-a-dependency) | ||
|
||
## Prerequisites | ||
|
||
* Kubernetes 1.18+ | ||
* Helm 3.7+ | ||
* PV provisioner support in the underlying infrastructure | ||
* _Recommended:_ cert-manager 1.4+ | ||
|
||
## Get Repo Info | ||
|
||
Helm's [experimental OCI registry support](https://helm.sh/docs/topics/registries/) is used for publishing and retrieving | ||
the FireFly Helm chart, as a result one must log into [GHCR](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) | ||
to download the chart: | ||
|
||
```shell | ||
export HELM_EXPERIMENTAL_OCI=1 | ||
|
||
helm registry login ghcr.io | ||
``` | ||
|
||
> **NOTE**: you must use a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) | ||
> when authenticating to the GHCR registry as opposed to using your GitHub password. | ||
|
||
## Install Chart | ||
|
||
```shell | ||
helm install [RELEASE_NAME] --version 0.5.0 oci://ghcr.io/hyperledger/helm/firefly-grafana-dashboards | ||
``` | ||
|
||
_See [configuration](#Configuration) below._ | ||
|
||
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ | ||
|
||
## Uninstall Chart | ||
|
||
```shell | ||
helm uninstall [RELEASE_NAME] | ||
``` | ||
|
||
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ | ||
|
||
## Upgrading Chart | ||
|
||
```shell | ||
helm upgrade [RELEASE_NAME] --install --version 0.5.0 oci://ghcr.io/hyperledger/helm/firefly-grafana-dashboards | ||
``` | ||
|
||
_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ | ||
|
||
## Using as a Dependency | ||
|
||
You can also use the FireFly chart within your own parent chart's `Chart.yaml`: | ||
|
||
```yaml | ||
dependencies: | ||
# ... | ||
- name: firefly-grafana-dashboards | ||
repository: "oci://ghcr.io/hyperledger/helm/" | ||
version: 0.5.0 | ||
``` | ||
|
||
Then download the chart dependency into your parent chart: | ||
|
||
```shell | ||
helm dep up path/to/parent-chart | ||
``` | ||
|
||
_See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._ | ||
|
||
## Configuration | ||
|
||
... label config |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs to be finished before merging