Merge pull request #312 from GoogleCloudPlatform/develop

Release 0.7.2-alpha

Author: heyealex

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,66 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior:
+
+1.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Actual behavior
+
+What happened instead.
+
+### Version (`ghpc --version`)
+
+### Blueprint
+
+If applicable, attach or paste the blueprint YAML used to produce the bug.
+
+```yaml
+
+```
+
+### Expanded Blueprint
+
+If applicable, please attach or paste the expanded blueprint. The expanded blueprint can be obtained by running `ghpc expand your-blueprint.yaml`.
+
+Disregard if the bug occurs when running `ghpc expand ...` as well.
+
+```yaml
+
+```
+
+### Output and logs
+
+```text
+
+```
+
+### Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+### Execution environment
+
+- OS: [macOS, ubuntu, ...]
+- Shell (To find this, run `ps -p $$`): [bash, zsh, ...]
+- go version:
+
+### Additional context
+
+Add any other context about the problem here.

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+### Submission Checklist
+
+* [ ] Have you installed and run this change against pre-commit? (`pre-commit
+  install`)
+* [ ] Are all tests passing? (`make tests`)
+* [ ] Have you written unit tests to cover this change?
+* [ ] Is unit test coverage still above 80%?
+* [ ] Have you updated all applicable documentation?
+* [ ] Have you followed the guidelines in our Contributing document?

Makefile

@@ -3,11 +3,11 @@ MIN_PACKER_VERSION=1.6 # for building images
 MIN_TERRAFORM_VERSION=1.0 # for deploying modules
 MIN_GOLANG_VERSION=1.16 # for building ghpc
 
-.PHONY: tests format add-google-license install-dev-deps \
+.PHONY: install install-user tests format add-google-license install-dev-deps \
         warn-go-missing warn-terraform-missing warn-packer-missing \
-				warn-go-version warn-terraform-version warn-packer-version \
-				test-engine validate_configs packer-check \
-				terraform-format packer-format \
+        warn-go-version warn-terraform-version warn-packer-version \
+        test-engine validate_configs packer-check \
+        terraform-format packer-format \
         check-tflint check-pre-commit
 
 ENG = ./cmd/... ./pkg/...
@@ -20,6 +20,21 @@ ghpc: warn-go-version warn-terraform-version warn-packer-version $(shell find ./
 	$(info **************** building ghpc ************************)
 	go build ghpc.go
 
+install-user:
+	$(info ******** installing ghpc in ~/bin *********************)
+	mkdir -p ~/bin
+	install -t ~/bin ./ghpc
+
+ifeq ($(shell id -u), 0)
+install:
+	$(info ***** installing ghpc in /usr/local/bin ***************)
+	install -t /usr/local/bin ./ghpc
+
+else
+install: install-user
+
+endif
+
 tests: warn-terraform-version warn-packer-version test-engine validate_configs packer-check
 
 format: warn-go-version warn-terraform-version warn-packer-version terraform-format packer-format

cmd/README.md

@@ -1,14 +1,42 @@
 # gHPC Commands
 
+## Usage
+
+```text
+gHPC provides a flexible and simple to use interface to accelerate
+HPC deployments on the Google Cloud Platform.
+
+Usage:
+  ghpc [flags]
+  ghpc [command]
+
+Available Commands:
+  completion  Generate completion script
+  create      Create a new deployment.
+  expand      Expand the Environment Blueprint.
+  help        Help about any command
+
+Flags:
+  -h, --help   help for ghpc
+
+Use "ghpc [command] --help" for more information about a command.
+```
+
 ## Create
 
 `ghpc create` takes as input a blueprint file and creates a deployment directory
 based on the requested components that can be used to deploy an HPC cluster on
-GCP
+GCP.
 
 ## Expand
 
 `ghpc expand` takes as input a blueprint file and expands all the fields
 necessary to create a deployment without actually creating the deployment
 directory. It outputs an expanded blueprint, which can be used for debugging
 purposes and can be used as input to `ghpc create`.
+
+## Completion
+Generates a script that enables command completion for `ghpc` for a given shell.
+
+## Help
+`ghpc help` prints the usage information from above to the console.

cmd/root.go

@@ -34,7 +34,7 @@ HPC deployments on the Google Cloud Platform.`,
 				log.Fatalf("cmd.Help function failed: %s", err)
 			}
 		},
-		Version: "v0.7.1-alpha (private preview)",
+		Version: "v0.7.2-alpha (private preview)",
 	}
 )
 

community/examples/intel/hpc-cluster-intel-select.yaml

@@ -22,11 +22,8 @@ vars:
   zone: us-central1-c
   controller_image_family: slurm-intel-hpc-controller
   compute_image_family: slurm-intel-hpc-compute
-  # this example works due to hard-coding the name of the VPC network and
-  # subnetwork created by the VPC module; we will resolve this in future
-  # ghpc releases
-  network_name: hpc-intel-select-net
-  subnetwork_name: hpc-intel-select-primary-subnet
+  network_name: intel-select-net
+  subnetwork_name: intel-select-primary-subnet
 
 deployment_groups:
 - group: primary

community/modules/compute/SchedMD-slurm-on-gcp-partition/versions.tf

@@ -21,6 +21,9 @@ terraform {
       version = ">= 3.83"
     }
   }
+  provider_meta "google" {
+    module_name = "blueprints/terraform/hpc-toolkit:SchedMD-slurm-on-gcp-partition/v0.7.2"
+  }
 
   required_version = ">= 0.14.0"
 }

community/modules/database/slurm-cloudsql-federation/versions.tf

@@ -29,6 +29,12 @@ terraform {
       version = "~> 3.0"
     }
   }
+  provider_meta "google" {
+    module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v0.7.2"
+  }
+  provider_meta "google-beta" {
+    module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v0.7.2"
+  }
 
   required_version = ">= 0.13.0"
 }

community/modules/file-system/nfs-server/versions.tf

@@ -25,6 +25,9 @@ terraform {
       version = "~> 3.0"
     }
   }
+  provider_meta "google" {
+    module_name = "blueprints/terraform/hpc-toolkit:nfs-server/v0.7.2"
+  }
 
   required_version = ">= 0.14.0"
 }

community/modules/project/service-enablement/versions.tf

@@ -21,7 +21,9 @@ terraform {
       version = ">= 3.83"
     }
   }
+  provider_meta "google" {
+    module_name = "blueprints/terraform/hpc-toolkit:service-enablement/v0.7.2"
+  }
 
   required_version = ">= 0.14.0"
 }
-