https://github.com/brantburnett/halyard-powershell
PowerShell module for using Halyard to manage Spinnaker via Docker containers
https://github.com/brantburnett/halyard-powershell
Last synced: 3 months ago
JSON representation
PowerShell module for using Halyard to manage Spinnaker via Docker containers
- Host: GitHub
- URL: https://github.com/brantburnett/halyard-powershell
- Owner: brantburnett
- License: apache-2.0
- Created: 2018-09-07T18:20:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-08T15:13:46.000Z (almost 4 years ago)
- Last Synced: 2025-01-14T10:18:37.700Z (5 months ago)
- Language: PowerShell
- Size: 27.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spinnaker Halyard PowerShell Module
[](https://travis-ci.org/brantburnett/halyard-powershell)
The Spinnaker Halyard PowerShell eases the use of [Halyard](https://www.spinnaker.io/reference/halyard/) to manage and deploy [Spinnaker](https://www.spinnaker.io/) using Docker containers. This avoids the need to install Halyard on your local machine, and enables the use of Halyard from Windows. However, it is compatible with PowerShell Core on Linux.
## Prerequisites
1. [Docker](https://www.docker.com/) or [Docker for Windows](https://docs.docker.com/docker-for-windows/install/)
2. If using Docker for Windows, the drive containing your user profile [must be shared](https://docs.docker.com/docker-for-windows/#shared-drives)
## Installation
To install from the PowerShell Gallery:
```powershell
Install-Module SpinnakerHalyard
```
To install from source:
```powershell
Import-Module .\SpinnakerHalyard.psd1
```
## Using Halyard
To use Halyard, first start the Halyard container.
```powershell
Start-Halyard
```
Then, execute commands using standard syntax.
```powershell
hal config version edit --version 1.9.1
hal deploy apply
```
To gain access to the Halyard files for more advanced configuration, get a Bash shell.
```powershell
Connect-Halyard
```
Finally, stop the Halyard container.
```powershell
Stop-Halyard
```
## Data Persistence
Halyard data in the ~/.hal directory is persisted, even after stopping the container. This is done via a
persistent Docker volume named "halyard". However, if this volume is deleted, for example by a pruning job
in Docker, the persisted data will be lost. Be sure to regularly using the `Backup-Halyard` command.
## Kubernetes Credentials
To facilitate access to Kubernetes credentials via Halyard, the local ~/.kube folder is mapped
to the ~/.kube folder within the container. This allows seamless access to these files.
```powershell
hal config provider kubernetes account add my-account --kubeconfig-file ~/.kube/config --context my-context
```
## Backup/Restore
When using this module, don't use the standard `hal backup create` and `hal backup restore` commands.
Instead, use the `Backup-Halyard` and `Restore-Halyard` commands, which handle moving the files between
the container and the local drive. Backups are stored in ${HOME}\.halbackups on the local drive.
```powershell
Backup-Halyard
Restore-Halyard ~\.halbackups\halbackup-Fri_Sep_07_14-13-34_UTC_2018.tar
```
## Commands
For a detailed command reference, see the help in PowerShell (i.e. `Get-Help Start-Halyard -Detailed`).