https://github.com/spinnaker/halyard
A tool for configuring, installing, and updating Spinnaker
https://github.com/spinnaker/halyard
hacktoberfest
Last synced: about 1 year ago
JSON representation
A tool for configuring, installing, and updating Spinnaker
- Host: GitHub
- URL: https://github.com/spinnaker/halyard
- Owner: spinnaker
- License: apache-2.0
- Created: 2016-09-26T17:55:37.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T15:49:42.000Z (over 1 year ago)
- Last Synced: 2025-04-06T16:02:07.218Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Java
- Homepage:
- Size: 7.67 MB
- Stars: 314
- Watchers: 50
- Forks: 704
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Authors: AUTHORS
Awesome Lists containing this project
README
# Halyard
A tool for configuring, installing, and updating Spinnaker.
[Halyard Docs](https://spinnaker.io/setup/install/halyard/) are available on [spinnaker.io](https://spinnaker.io)
## Installation
> __NOTICE:__ This tool is in Beta - some behavior may still change. Please
> report any bugs/problems/questions on [the issue
> tracker](https://github.com/spinnaker/spinnaker/issues) or in
> [slack](https://join.spinnaker.io).
```
$ curl -O https://raw.githubusercontent.com/spinnaker/halyard/master/install/debian/InstallHalyard.sh
$ sudo bash InstallHalyard.sh
```
# Overview
There are three parts to Halyard, the __halconfig__, the __daemon__, and
__hal__. In short, __hal__ is a Command Line Interface (CLI) that sends
commands to the __daemon__ to update the __halconfig__, which is ultimately
the source of all configuration for your Spinnaker deployment.
## halconfig
The __halconfig__ is a file that is central to how Halyard configures your Spinnaker
deployment. Its goal is to centralize all configuration for your Spinnaker
deployment (how to authenticate against your cloud providers, which CI system
is in use, Spinnaker monitoring, etc...).
For a detailed description, please read the [design doc](docs/design.md)
## daemon
The __daemon__ validates and generates Spinnaker config using your
__halconfig__. It must run on a machine that has any credentials needed by
Spinnaker in order to validate your configuration.
### debugging
To run a daemon locally for JVM debugging, set the java system property ```DEBUG=true```. For example:
```
./gradlew halyard-web:run -DDEBUG=true
```
It listens for the debugger on port 9099, and does _not_ wait for the debugger before running
halyard. To change these, check out the relevant bits in halyard-web/halyard-web.gradle
## hal
__hal__ is a CLI for making changes to your __halconfig__ via the __daemon__.
Read the command reference [here](docs/commands.md).
[icon]: https://github.com/AnderMendoza/halyard/blob/master/spinnaker-seeklogo.com.svg