Merge pull request #102 from google/v0.3.1

v0.3.1

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,7 +17,7 @@ Please mark one option with an "x".
 Please mark one option with an "x".
 
 - [ ] #RELEASE New Collection of Features (containing breaking and non-breaking changes)
-- [ ] #FT New feature (non-breaking change which adds functionality, imrproves performance or code quality)
+- [ ] #FT New feature (non-breaking change which adds functionality, improves performance or code quality)
 - [ ] #BUG Bug Fix (non-breaking change which fixes an issue)
 - [ ] #PATCH Patch (non-breaking change which modifies only non-code object [Docs, Readme])
 

.github/dependabot.yml

@@ -0,0 +1,96 @@
+# Basic set up for three package managers
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "github"
+      prefix: "github"
+    # Specify labels for pull requests
+    labels:
+      - "github"
+      - "dependencies"
+    open-pull-requests-limit: 2
+    target-branch: "develop"
+    # Add reviewers
+    reviewers:
+      - "google/shifter-core-developers"
+
+  # Maintain dependencies for Shifter UI - NPM Modules
+  - package-ecosystem: "npm"
+    directory: "/shifter-ui"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "npm"
+      prefix: "npm"
+    # Specify labels for pull requests
+    labels:
+      - "npm"
+      - "dependencies"
+    open-pull-requests-limit: 2
+    target-branch: "develop"
+    # Add reviewers
+    reviewers:
+      - "google/shifter-core-developers"
+
+  # Maintain dependencies for Shifter UI - Dockerfiles
+  - package-ecosystem: "docker"
+    directory: "/shifter-ui"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "docker"
+      prefix: "docker"
+    # Specify labels for pull requests
+    labels:
+      - "docker"
+      - "dependencies"
+    open-pull-requests-limit: 2
+    target-branch: "develop"
+    # Add reviewers
+    reviewers:
+      - "google/shifter-core-developers"
+
+  # Maintain dependencies for Shifter Core - Go Modules
+  - package-ecosystem: "gomod"
+    directory: "/shifter"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "go-mod"
+      prefix: "go-mod"
+    # Specify labels for pull requests
+    labels:
+      - "go-mod"
+      - "dependencies"
+    open-pull-requests-limit: 2
+    target-branch: "develop"
+    # Add reviewers
+    reviewers:
+      - "google/shifter-core-developers"
+
+  # Maintain dependencies for Shifter Core - Dockerfiles
+  - package-ecosystem: "docker"
+    directory: "/shifter"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "docker"
+      prefix: "docker"
+    # Specify labels for pull requests
+    labels:
+      - "docker"
+      - "dependencies"
+    open-pull-requests-limit: 2
+    target-branch: "develop"
+    # Add reviewers
+    reviewers:
+      - "google/shifter-core-developers"
+
+

.github/workflows/auto-tag-release.yml

@@ -1,3 +1,17 @@
+# 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.
+
 name: Bump & Tag New Release
 on:
   push:
@@ -13,4 +27,5 @@ jobs:
       - uses: rymndhng/release-on-push-action@master
         with:
           bump_version_scheme: patch
-          use_github_release_notes: true
+          use_github_release_notes: true
+

README.md

@@ -41,47 +41,71 @@ contributors to follow.
 
 For development see [DEVELOPMENT.md](DEVELOPMENT.md) for details on pre-requisites and style guides.
 
-
 ## Components
 
 Shifter can either be ran via the command line or via a web ui front end.
 
-### Shifter
+### Shifter Core (CLI & API Server)
 
 Provides the backend service required by the front-end application and also provides the CLI tooling if the front-end web interface is not required.
 
-##### Releases
-
-*  Binaries - [https://github.com/google/shifter/releases](https://github.com/google/shifter/releases)
-*  Docker Image - []()
-
-##### Documentation 
+#### Documentation 
 
 Read the detailed documentation at [shifter/README.md](shifter/README.md)
 
-##### Demo
+#### Demo
 
 <p float="left">
 	<img src="assets/shifter-cluster-demo.gif" alt="shifter demo 1" />
 </p>
 
-### Shifter-UI
 
-Provides a front-end application written in Vue that connects to the Shfiter API's, for more information see ![shifter-ui/readme.md](shifter-ui/README.md)
-##### Run The Latest Version Locally 
+### Shifter UI
 
-1) Get the Source & Run Latest the latest Docker Release
-```
+Provides a front-end application written in Vue that connects to the Shfiter API's, for more information see [shifter-ui/readme.md](shifter-ui/README.md)
+
+## Releases
+
+*  Binaries - [https://github.com/google/shifter/releases](https://github.com/google/shifter/releases)
+*  Shifter Core Docker Image - docker pull images.shifter.cloud/shifter:latest
+*  Shifter UI   Docker Image - docker pull images.shifter.cloud/shifter-ui:latest
+
+## Run Shifter
+
+### Run The Latest Shifter Version Locally with the UI
 
+1) Get the Source & Run Latest Docker Release
+```
 git clone https://github.com/google/shifter 
 cd shifter
 docker-compose -f docker-compose.yml up
+```
+
+2) Open a browser and go to [http://localhost:9090](http://localhost:9090)
+
+
+### Run The Latest Shifter Version Locally wth the CLI
 
+1) Run the Latest Docker Release (With List Action)
 ```
+export CLUSTER_ENDPOINT="https://console.okd.<CLUSTER_DOMAIN>:8443"
+export BEARER_TOKEN="<BEARER_TOKEN>"
 
-## Google Cloud Deployment
+docker run \
+images.shifter.cloud/shifter:latest \
+./shifter cluster -e $OKD_ENDPOINT -t $OKD_TOKEN list --all-namespaces
+```
+
+2) Run the Latest Docker Release (With an Export Action)
+```
+export CLUSTER_ENDPOINT="https://console.okd.<CLUSTER_DOMAIN>:8443"
+export BEARER_TOKEN="<BEARER_TOKEN>"
 
-Deployment to other cloud providers should be possible but has not been tested.
+docker run \
+-v 'pwd':/output \
+images.shifter.cloud/shifter:latest \
+./shifter cluster -e $CLUSTER_ENDPOINT -t $BEARER_TOKEN export --all-namespaces /output
+```
 
 ## Stargazers over time
 

build-deploy-local.sh

@@ -1,3 +1,17 @@
+# 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.
+
 # Removing Existing Local Development Containers
 docker container rm -f shifter_ui_development 
 docker container rm -f shifter_server_development 
@@ -18,4 +32,4 @@ docker build  --no-cache -t local.images.shifter.cloud/shifter-ui:latest -f "./s
 docker build  --no-cache -t local.images.shifter.cloud/shifter:latest -f "./shifter/Dockerfile" ./shifter/
 
 # Docker Compose Up - Run It!
-docker-compose -f docker-compose-development.yml up --force-recreate
+docker-compose -f docker-compose-development.yml up --force-recreate

docker-compose-development.yml

@@ -1,3 +1,17 @@
+# 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.
+
 version: "3"
 services:
   shifter-ui:

docker-compose.yml

@@ -1,3 +1,17 @@
+# 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.
+
 version: "3"
 services:
   shifter-ui:

okd-cluster/3.11/terraform/backend.tf

@@ -1,3 +1,19 @@
+/**
+ * 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.
+ */
+
 terraform {
   backend "gcs" {
     bucket = "okd-tf01"

okd-cluster/3.11/terraform/compute.tf

@@ -1,3 +1,19 @@
+/**
+ * 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.
+ */
+
 data "google_compute_zones" "zones" {
   region  = var.region
   project = module.project.project_id

okd-cluster/3.11/terraform/dns.tf

@@ -1,3 +1,19 @@
+/**
+ * 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.
+ */
+
 resource "google_dns_managed_zone" "okd-gcp-zone" {
   project     = module.project.project_id
   name        = "okd-gcp-iac"

okd-cluster/3.11/terraform/iam.tf

@@ -1,3 +1,19 @@
+/**
+ * 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.
+ */
+
 resource "google_service_account" "os-service" {
   project      = module.project.project_id
   account_id   = "${var.prefix}-os-svc"

okd-cluster/3.11/terraform/inventory.tf

@@ -1,3 +1,19 @@
+/**
+ * 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.
+ */
+
 data "template_file" "inventory" {
   template = "${file("${path.cwd}/okd-template/ansible-hosts.template.txt")}"
   vars = {