Skip to content

Commit b265dcb

Browse files
garybowersgarybowers
authored
Merge pull request #102 from google/v0.3.1
v0.3.1
2 parents 4777e17 + 6051507 commit b265dcb

File tree

177 files changed

+5845
-3042
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+5845
-3042
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Please mark one option with an "x".
1717
Please mark one option with an "x".
1818

1919
- [ ] #RELEASE New Collection of Features (containing breaking and non-breaking changes)
20-
- [ ] #FT New feature (non-breaking change which adds functionality, imrproves performance or code quality)
20+
- [ ] #FT New feature (non-breaking change which adds functionality, improves performance or code quality)
2121
- [ ] #BUG Bug Fix (non-breaking change which fixes an issue)
2222
- [ ] #PATCH Patch (non-breaking change which modifies only non-code object [Docs, Readme])
2323

‎.github/dependabot.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Basic set up for three package managers
2+
3+
version: 2
4+
updates:
5+
6+
# Maintain dependencies for GitHub Actions
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "daily"
11+
commit-message:
12+
# Prefix all commit messages with "github"
13+
prefix: "github"
14+
# Specify labels for pull requests
15+
labels:
16+
- "github"
17+
- "dependencies"
18+
open-pull-requests-limit: 2
19+
target-branch: "develop"
20+
# Add reviewers
21+
reviewers:
22+
- "google/shifter-core-developers"
23+
24+
# Maintain dependencies for Shifter UI - NPM Modules
25+
- package-ecosystem: "npm"
26+
directory: "/shifter-ui"
27+
schedule:
28+
interval: "daily"
29+
commit-message:
30+
# Prefix all commit messages with "npm"
31+
prefix: "npm"
32+
# Specify labels for pull requests
33+
labels:
34+
- "npm"
35+
- "dependencies"
36+
open-pull-requests-limit: 2
37+
target-branch: "develop"
38+
# Add reviewers
39+
reviewers:
40+
- "google/shifter-core-developers"
41+
42+
# Maintain dependencies for Shifter UI - Dockerfiles
43+
- package-ecosystem: "docker"
44+
directory: "/shifter-ui"
45+
schedule:
46+
interval: "daily"
47+
commit-message:
48+
# Prefix all commit messages with "docker"
49+
prefix: "docker"
50+
# Specify labels for pull requests
51+
labels:
52+
- "docker"
53+
- "dependencies"
54+
open-pull-requests-limit: 2
55+
target-branch: "develop"
56+
# Add reviewers
57+
reviewers:
58+
- "google/shifter-core-developers"
59+
60+
# Maintain dependencies for Shifter Core - Go Modules
61+
- package-ecosystem: "gomod"
62+
directory: "/shifter"
63+
schedule:
64+
interval: "daily"
65+
commit-message:
66+
# Prefix all commit messages with "go-mod"
67+
prefix: "go-mod"
68+
# Specify labels for pull requests
69+
labels:
70+
- "go-mod"
71+
- "dependencies"
72+
open-pull-requests-limit: 2
73+
target-branch: "develop"
74+
# Add reviewers
75+
reviewers:
76+
- "google/shifter-core-developers"
77+
78+
# Maintain dependencies for Shifter Core - Dockerfiles
79+
- package-ecosystem: "docker"
80+
directory: "/shifter"
81+
schedule:
82+
interval: "daily"
83+
commit-message:
84+
# Prefix all commit messages with "docker"
85+
prefix: "docker"
86+
# Specify labels for pull requests
87+
labels:
88+
- "docker"
89+
- "dependencies"
90+
open-pull-requests-limit: 2
91+
target-branch: "develop"
92+
# Add reviewers
93+
reviewers:
94+
- "google/shifter-core-developers"
95+
96+

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

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
name: Bump & Tag New Release
216
on:
317
push:
@@ -13,4 +27,5 @@ jobs:
1327
- uses: rymndhng/release-on-push-action@master
1428
with:
1529
bump_version_scheme: patch
16-
use_github_release_notes: true
30+
use_github_release_notes: true
31+

‎README.md‎

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,47 +41,71 @@ contributors to follow.
4141

4242
For development see [DEVELOPMENT.md](DEVELOPMENT.md) for details on pre-requisites and style guides.
4343

44-
4544
## Components
4645

4746
Shifter can either be ran via the command line or via a web ui front end.
4847

49-
### Shifter
48+
### Shifter Core (CLI & API Server)
5049

5150
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.
5251

53-
##### Releases
54-
55-
* Binaries - [https://github.com/google/shifter/releases](https://github.com/google/shifter/releases)
56-
* Docker Image - []()
57-
58-
##### Documentation
52+
#### Documentation
5953

6054
Read the detailed documentation at [shifter/README.md](shifter/README.md)
6155

62-
##### Demo
56+
#### Demo
6357

6458
<p float="left">
6559
<img src="assets/shifter-cluster-demo.gif" alt="shifter demo 1" />
6660
</p>
6761

68-
### Shifter-UI
6962

70-
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)
71-
##### Run The Latest Version Locally
63+
### Shifter UI
7264

73-
1) Get the Source & Run Latest the latest Docker Release
74-
```
65+
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)
66+
67+
## Releases
68+
69+
* Binaries - [https://github.com/google/shifter/releases](https://github.com/google/shifter/releases)
70+
* Shifter Core Docker Image - docker pull images.shifter.cloud/shifter:latest
71+
* Shifter UI Docker Image - docker pull images.shifter.cloud/shifter-ui:latest
72+
73+
## Run Shifter
74+
75+
### Run The Latest Shifter Version Locally with the UI
7576

77+
1) Get the Source & Run Latest Docker Release
78+
```
7679
git clone https://github.com/google/shifter
7780
cd shifter
7881
docker-compose -f docker-compose.yml up
82+
```
83+
84+
2) Open a browser and go to [http://localhost:9090](http://localhost:9090)
85+
86+
87+
### Run The Latest Shifter Version Locally wth the CLI
7988

89+
1) Run the Latest Docker Release (With List Action)
8090
```
91+
export CLUSTER_ENDPOINT="https://console.okd.<CLUSTER_DOMAIN>:8443"
92+
export BEARER_TOKEN="<BEARER_TOKEN>"
8193
82-
## Google Cloud Deployment
94+
docker run \
95+
images.shifter.cloud/shifter:latest \
96+
./shifter cluster -e $OKD_ENDPOINT -t $OKD_TOKEN list --all-namespaces
97+
```
98+
99+
2) Run the Latest Docker Release (With an Export Action)
100+
```
101+
export CLUSTER_ENDPOINT="https://console.okd.<CLUSTER_DOMAIN>:8443"
102+
export BEARER_TOKEN="<BEARER_TOKEN>"
83103
84-
Deployment to other cloud providers should be possible but has not been tested.
104+
docker run \
105+
-v 'pwd':/output \
106+
images.shifter.cloud/shifter:latest \
107+
./shifter cluster -e $CLUSTER_ENDPOINT -t $BEARER_TOKEN export --all-namespaces /output
108+
```
85109

86110
## Stargazers over time
87111

‎build-deploy-local.sh‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
# Removing Existing Local Development Containers
216
docker container rm -f shifter_ui_development
317
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
1832
docker build --no-cache -t local.images.shifter.cloud/shifter:latest -f "./shifter/Dockerfile" ./shifter/
1933

2034
# Docker Compose Up - Run It!
21-
docker-compose -f docker-compose-development.yml up --force-recreate
35+
docker-compose -f docker-compose-development.yml up --force-recreate

‎docker-compose-development.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
version: "3"
216
services:
317
shifter-ui:

‎docker-compose.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
version: "3"
216
services:
317
shifter-ui:

‎okd-cluster/3.11/terraform/backend.tf‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/**
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
terraform {
218
backend "gcs" {
319
bucket = "okd-tf01"

‎okd-cluster/3.11/terraform/compute.tf‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/**
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
data "google_compute_zones" "zones" {
218
region = var.region
319
project = module.project.project_id

‎okd-cluster/3.11/terraform/dns.tf‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/**
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
resource "google_dns_managed_zone" "okd-gcp-zone" {
218
project = module.project.project_id
319
name = "okd-gcp-iac"

0 commit comments

Comments
 (0)