Document project cleanup utility

Author: Jberlinsky

examples/project_cleanup/README.md

@@ -0,0 +1,25 @@
+# Old Project Cleanup Utility Module
+
+This example module schedules a job to clean up GCP projects older than a specified length of time, that match a particular key-value pair. This job runs every 5 minutes via Google Cloud Scheduled Functions. Please see the [utility's readme](./function_source/README.md) for more information as to its operation and configuration.
+
+Running this module requires an App Engine app in the specified project/region, which is not handled by this example. More information is in the [root readme](../../README.md#app-engine).
+
+[^]: (autogen_docs_start)
+
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| organization_id | The organization ID whose projects to clean up | string | - | yes |
+| project_id | The project ID to host the scheduled function in | string | - | yes |
+| region | The region the project is in (App Engine specific) | string | `us-central1` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| name | The name of the job created |
+| project_id | The project ID |
+
+[^]: (autogen_docs_end)

examples/project_cleanup/function_source/README.md

@@ -0,0 +1,20 @@
+# Project Cleanup Utility
+
+This is a simple utility that scans a GCP organization for projects matching certain criteria, and enqueues such projects for deletion. Currently supported criteria are the combination of:
+
+- **Age:** Only projects older than the configured age, in hours, will be marked for deletion.
+- **Key-Value Pair:** Only projects whose labels contain the provided key-value pair will be marked for deletion.
+
+## Environment Configuration
+
+The following environment variables may be specified to configure the cleanup utility:
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| `TARGET_TAG_NAME` | The tag name to match on for identifying projects to delete | string | n/a | yes |
+| `TARGET_TAG_VALUE` | The tag value to match on for identifying projects to delete | string | n/a | yes |
+| `MAX_PROJECT_AGE_HOURS` | The project age, in hours, at which point deletion should be considered | integer | n/a | yes |
+
+## Required Permissions
+
+This Cloud Function must be run as a Service Account with the `owner` role at an organization level.

examples/project_cleanup/function_source/main.go

@@ -1,16 +1,18 @@
-// Copyright 2019 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.
+/*
+Copyright 2019 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
+
+    https://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.
+*/
 
 package project_cleaner