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

Create a production deployment guide #123

Open
paulhowardarm opened this issue Jul 22, 2021 · 0 comments
Open

Create a production deployment guide #123

paulhowardarm opened this issue Jul 22, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@paulhowardarm
Copy link
Contributor

Summary

We need a full deployment guide aimed at people who want to go to production with Parsec. It can reference some of the existing material, but it needs to be something that guides people through the process of installation, choosing the right back-end, choosing the right auth model, and finally validating that the installation is correct.

Details

This might be an opportunity to restructure the book a little bit as well. We currently have some really useful deployment materials, but they are scattered around, most notably in the "Parsec for Service Developers" section, which is not really the right place because people who want to successfully install/deploy/integrate Parsec are not necessarily people who actually want to do service development, in fact they typically wouldn't be.

The deployment guide should be a new page or possibly the main page of a new "Parsec Deployment Guide" chapter in the book. Existing pages that might then move into this chapter would include the secure installation steps, security recommendations and configuration guide.

The main page can and will reference other docs, but it can't just be a jumble of links. It needs to coach people through the process in a linear fashion.

Some things to include:

  • Installation, with some specialised info about Fedora and openSUSE where Parsec is a supported package. Show the installation commands for those systems. Reference the Yocto recipes for people who are creating Yocto images with Parsec. Finally, reference the existing secure installation guide for people who need to set up manually.
  • Advice on choosing the right back-end, and a reference to configuration steps.
  • Advice on choosing the right authenticator - pros and cons of using OS permissions to protect the socket, and help people to understand how Parsec will treat the incoming API calls from different apps or containers.
  • Show how to do parsec-tool ping, parsec-tool list-providers and parsec-tool list-authenticators with sample output, and explain that these can be used to validate that the expected configuration has taken effect.
  • Link to instructions for running end-to-end tests or any other relevant tests.

Definition of Done

Create first version of content - just needs PR review and merge. We will doubtless want to evolve this over time.

@paulhowardarm paulhowardarm added the documentation Improvements or additions to documentation label Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant