initial commit

Author: Scaffolder

.adr-dir

@@ -0,0 +1 @@
+docs/adr

.envrc

@@ -0,0 +1,3 @@
+# shellcheck shell=bash
+
+dotenv_if_exists

.github/CODEOWNERS

@@ -0,0 +1,38 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+#*       @global-owner1 @global-owner2
+*       @broadinstitute/5cc-cga
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+#*.js    @js-owner
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+#*.go [email protected]
+
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+#/build/logs/ @doctocat
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+#docs/*  [email protected]
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+#apps/ @octocat
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository.
+#/docs/ @doctocat

.github/dependabot.yml

@@ -0,0 +1,12 @@
+---
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    groups:
+      actions:
+        patterns:
+          - '*'
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: 'weekly'

.github/pull_request_template.md

@@ -0,0 +1,31 @@
+---
+## Write Good Commit Messages
+
+[The seven rules of a great Git commit message](https://cbea.ms/git-commit/)
+
+* Separate subject from body with a blank line
+* Limit the subject line to 50 characters
+* Capitalize the subject line
+* Do not end the subject line with a period
+* Use the imperative mood in the subject line
+* Wrap the body at 72 characters
+* Use the body to explain what and why vs. how
+
+## Update Providers
+When updating a provider, run the following command to update the lock file. This will ensure that the provider is available for all platforms.
+
+```Shell
+terraform providers lock \
+  -platform=linux_arm64 \
+  -platform=linux_amd64 \
+  -platform=darwin_amd64 \
+  -platform=darwin_arm64 \
+  -platform=windows_amd64
+```
+
+## Update Docs
+When updating docs, run the following command in the directory you want to update (dev/prod). This will ensure that the docs are available for all platforms.
+
+```Shell
+docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:latest --output-file README.md --output-mode inject /terraform-docs
+```

.github/workflows/checks.yaml

@@ -0,0 +1,11 @@
+---
+name: 'checks'
+
+'on':
+  pull_request:
+    branches:
+      - 'main'
+
+jobs:
+  conventional-commits:
+    uses: broadinstitute/shared-workflows/.github/workflows/[email protected]

.github/workflows/close-stale.yaml

@@ -0,0 +1,10 @@
+---
+name: 'Close stale issues and PRs'
+
+'on':
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    uses: broadinstitute/shared-workflows/.github/workflows/[email protected]

.gitignore

@@ -0,0 +1,53 @@
+# https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# https://github.com/github/gitignore/blob/main/Global/Windows.gitignore
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

catalog-info.yaml

@@ -0,0 +1,19 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: kubernetes-netbox
+  description: netbox
+  tags:
+    - gcp
+    - networking
+  annotations:
+    github.com/project-slug: broadinstitute/kubernetes-netbox
+    backstage.io/source-template: template:default/create-repo
+    backstage.io/techdocs-ref: dir:.
+    backstage.io/kubernetes-id: kubernetes-netbox
+spec:
+  type: website
+  lifecycle: production
+  owner: 5cc-cga
+  system: kubernetes
+  domain: infrastructure-tools

docs/README.md

@@ -0,0 +1,29 @@
+## kubernetes-netbox
+
+
+
+## Getting started
+
+Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file.
+For more info visit [TechDoc](https://backstage.io/docs/features/techdocs/) and [TechDocs at Broad](https://backstage.broadinstitute.org/catalog/default/component/backstage/docs/techdocs/)
+
+## Table of Contents
+
+The Table of Contents on the right is generated automatically based on the hierarchy
+of headings. Only use one H1 (`#` in Markdown) per file.
+
+## Site navigation
+
+For new pages to appear in the left hand navigation you need edit the `mkdocs.yml`
+file in root of your repo. The navigation can also link out to other sites.
+
+Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation section
+will be created for you. However, you will not be able to use alternate titles for
+pages, or include links to other sites.
+
+Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work.
+See also <https://www.mkdocs.org/user-guide/configuration/>.
+
+## Support
+
+That's it. If you need support, reach out in [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) on Discord.