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

Feature/vault documentation #1393

Merged
merged 4 commits into from
Jun 29, 2020

Conversation

erzetpe
Copy link
Contributor

@erzetpe erzetpe commented Jun 29, 2020

No description provided.

Additional changes to how to documentation for Vault

Add Vault Helm Chart to components

Additional documentation to howto for Vault

Fix description in the task

Further changest to Vault documentation

Next part of security documentation for Vault
@erzetpe
Copy link
Contributor Author

erzetpe commented Jun 29, 2020

This is documentation for issues: #1191, #1190.

@erzetpe erzetpe requested a review from ar3ndt June 29, 2020 12:58
Copy link
Contributor

@mkyc mkyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments, but looks good to me.

docs/home/howto/SECURITY.md Show resolved Hide resolved
enable_vault_audit_logs: false # turn on audit logs that can be found at /opt/vault/logs/vault_audit.log
enable_vault_ui: false # enable Vault UI, shouldn't be used at production
vault_script_autounseal: true # enable automatic unseal vault at the start of the service, shouldn't be used at production
vault_script_autoconfiguration: true # enable automatic configuration of Hashicorp Vault
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that should be explained more. What auto configuration is doing? What is being configured?


### Manual unsealing of the Vault

When Hashicorp Vault starts it starts in sealed mode. This mean that Vault data is encrypted and Vault needs to generate key
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rephrase it a bit. Something like: "By design Hashicorp Vault starts in sealed mode."


### Manual unsealing of the Vault

When Hashicorp Vault starts it starts in sealed mode. This mean that Vault data is encrypted and Vault needs to generate key
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data is encrypted and Vault needs to generate key ... isn't it bit incorrect? I think it should be: data is encrypted and operator needs to provide unsealing key or something similar.

vault operator unseal
```

and passing three unseal keys from /opt/vault/init.txt file. In the future number of keys will be defined from the level
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future releases, number ...

@erzetpe erzetpe merged commit 5421e7a into hitachienergy:develop Jun 29, 2020
@erzetpe erzetpe deleted the feature/vault-documentation branch June 29, 2020 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants