Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction
The plugin basically provides the capability to enable the atlas as a secret engine which will store the ATLAS api secrets and make them persistent. The GlobalSign Atlas secret engine generates, issues, and manages certificates dynamically in your ATLAS account. This simplifies certificate issuance and life cycle management, as the engine can manage key generation, life cycle. Additionally this enables codifying and mapping issuance policy to internal authentication methods such as public cloud credentials or SSO solutions.
# GlobalSign Atlas Certificate Provider Plugin for Hashicorp Vault

`atlas-hashicorp-vault` plugin lets you manage issue GlobalSign Atlas backed certificates in vault.
Expand All @@ -10,6 +12,19 @@
## Demo
[![asciicast](https://asciinema.org/a/K5k9khe33IN7Ewot6yMN6yjBB.svg)](https://asciinema.org/a/K5k9khe33IN7Ewot6yMN6yjBB)
## Installation
Below are the installations steps for ubuntu 20.04 or above

Golang installation
a. $sudo apt install golang -y

Update the packages
a. $sudo apt-get update && sudo apt-get upgrade -y
b. sudo apt install net-tools

Installing HC Vault Packages.
a. $wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
b. $echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
c. $sudo apt update && sudo apt install vault

Before you can use the Plugin's API you will need to install the vault plugin:

Expand All @@ -22,7 +37,7 @@ _**(Note: We have automated most of these steps and user can directly navigate t
plugin are released.

```bash
$ curl https://github.com/globalsign/atlas-hashicorp-vault/releases/latest/download/atlas-linux-amd64 -o /etc/vault/vault_plugins/atlas
$ sudo mkdir -p /etc/vault/vault_plugins/ && sudo curl https://github.com/globalsign/atlas-hashicorp-vault/releases/latest/download/atlas-linux-amd64 -o /etc/vault/vault_plugins/atlas
$ chmod +x /etc/vault/vault_plugins/atlas
```

Expand All @@ -45,7 +60,7 @@ _**(Note: We have automated most of these steps and user can directly navigate t
5. Get the SHA-256 checksum of the `atlas-hashicorp-vault` plugin binary:

```bash
$ PLUGIN_SHA256=$(sha256sum /etc/vault/vault_plugins/atlas-hashicorp-vault | cut -d' ' -f1)
$ PLUGIN_SHA256=$(sha256sum /etc/vault/vault_plugins/atlas | cut -d' ' -f1)
```

6. Register the `atlas-hashicorp-vault` plugin in the Vault
Expand Down
Loading