custodia icon indicating copy to clipboard operation
custodia copied to clipboard

Document deployment guide

Open JAORMX opened this issue 8 years ago • 5 comments

Besides the minimal example referenced in #36, having a small deployment guide that describes how to deploy with some common scenarios would be very beneficial.

JAORMX avatar Apr 03 '17 11:04 JAORMX

Do you have an example in mind I can look out at ? I want to take on this soon.

simo5 avatar Apr 03 '17 15:04 simo5

So it could be something similar to https://docs.openstack.org/ocata/install-guide-rdo/keystone.html where a basic installation workflow is followed, as well as operations that deployers would usually do and how to verify them.

And if possible some "advanced features" that people might actually need; such as security hardening and such.

JAORMX avatar Apr 03 '17 15:04 JAORMX

Thanks, will take a look and start implementing what I can.

simo5 avatar Apr 03 '17 15:04 simo5

Deployment should be either via package manager or with pip in a virtual env. Installation with sudo pip install custodia in global site-packages should be discourage. I don't want to support it because it tends to break either custodia, the system or both.

tiran avatar Apr 05 '17 15:04 tiran

@tiran I agree that sudo pip install custodia shouldn't be encouraged. And that's the aim of having a deployment guide. To tell folks right ways of doing things such as installing and configuring the service.

JAORMX avatar Apr 05 '17 15:04 JAORMX