README.md

Description

Creates a monitoring dashboard for the HPC cluster deployment. The module includes a default HPC-focused dashboard with the ability to add custom widgets as well as the option to add an empty dashboard and add widgets as needed.

Example

- id: hpc_dash
  source: modules/monitoring/dashboard
  settings:
    widgets:
    - |
      {
        "text": {
          "content": "## Header",
          "format": "MARKDOWN"
        },
        "title": "Custom Text Block Widget"
      }

This module creates a dashboard based on the HPC dashboard (default) with an extra text widget added as a multi-line string representing a JSON block.

License

Copyright 2022 Google LLC

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://www.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.

Requirements

Name	Version
terraform	>= 0.14.0
google	>= 3.83

Providers

Name	Version
google	>= 3.83

Modules

No modules.

Resources

Name	Type
google_monitoring_dashboard.dashboard	resource

Inputs

Name	Description	Type	Default	Required
base_dashboard	Baseline dashboard template, select from HPC or Empty	string	"HPC"	no
deployment_name	The name of the current deployment	string	n/a	yes
labels	Labels to add to the monitoring dashboard instance. Key-value pairs.	map(string)	n/a	yes
project_id	Project in which the HPC deployment will be created	string	n/a	yes
title	Title of the created dashboard	string	"Cluster Toolkit Dashboard"	no
widgets	List of additional widgets to add to the base dashboard.	list(string)	[]	no

Outputs

Name	Description
instructions	Instructions for accessing the monitoring dashboard