Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Autodesk/shore
https://github.com/Autodesk/shore
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Autodesk/shore
- Owner: Autodesk
- License: apache-2.0
- Created: 2022-09-07T16:48:02.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-10T19:58:31.000Z (about 1 year ago)
- Last Synced: 2024-07-08T05:33:43.618Z (3 months ago)
- Language: Go
- Size: 7.62 MB
- Stars: 17
- Watchers: 8
- Forks: 2
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome - Autodesk/shore - (others)
README
# Shore
Shore (verb) is a tool used to develop deployment pipelines for different pipeline based products like Spinnaker.
## Installing shore
### As a binary
#### Released
1. Shore released binaries can be found in archived format at shore's github releases page:
2. To download the binary relevant for you platform click on the file name and save the file to the disk.
3. Un-archive, e.g. for tar.gz for Mac OS:
```shell
cd ~/Downloads
tar -xzf shore_0.0.2_Darwin_x86_64.tar.gz -C /usr/local/bin/
chmod +x /usr/local/bin/shore
shore -h
```
#### Current/Nightly build
### As a docker image
1. Shore released docker images links can be found at shore's github releases page:
```shell
docker pull ***REMOVED***/shore/shore:v0.0.2
docker run ***REMOVED***/shore/shore:v0.0.2 -h
```
## Building Shore
```bash
git clone [email protected]:Autodesk/shore.git
go mod download
go mod vendor
go build -o shore cmd/shore/shore.go
./shore
```
### Reading/Rendering files
JSONNET/{INSERT LANGUAGE} files will read from `./{project_path}/main.pipeline.jsonnet`.
Only top level files that generate a `Pipeline` object will be rendered.
```bash
{project_path}/main.pipeline.jsonnet # RENDERS A PIPELINE
# ---- DOES NOT RENDER A PIPELINE ----
{project_path}/pipelines/MYSUBDIRECTORY/not-really-main.jsonnet
```
`Pipeline` objects can be identified using a validation method that conforms to one of the supported backends.
### Saving to a backend
The rendered output is stored in Memory and is passed on to the correct backend service provider.
As of today (30 Mar 2021) only Spinnaker is supported as a backend service.
The framework will not validate the input before pushing to a backend as combinations may be very tricky to validate.
Instead the framework will try to provide known good values for a specific backend configuration (I.E. Spinnaker)
### Tools
The framework will provide a few packages and functions for customer's to consume.
These packages will be made available through the common resources and identified at runtime.
To get these common resources, we recommend using [Jsonnet-Bundler](https://github.com/jsonnet-bundler/jsonnet-bundler/)
## Release