From 82445266398f7f976abe387e64f3439924833639 Mon Sep 17 00:00:00 2001 From: Marvin Brown Date: Mon, 10 May 2021 17:09:46 -0500 Subject: [PATCH] Initial chechin to standardize documentations for Anchore Enterprise --- docs/Security.md | 26 ++++++++++++++++++++++++ docs/Troubleshooting.md | 14 +++++++++++++ docs/overview.md | 44 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 docs/Security.md create mode 100644 docs/Troubleshooting.md create mode 100644 docs/overview.md diff --git a/docs/Security.md b/docs/Security.md new file mode 100644 index 0000000..0973d09 --- /dev/null +++ b/docs/Security.md @@ -0,0 +1,26 @@ +# Security + +Anchore Enterprise supports user login to the User Interface through identities from external identity providers that support Security Assertion Markup Language (SAML). Anchore +does not store any user credentials. However, usernames and anchore permissions are stored. The identity provider validates the user's access while an external provider validates the username and all first time user login information. + +The Anchore Enterprise deployment must be configured to utilize the SAML SSO. + + +- It is required to Enable Oauth to ensure that Anchore can issue bearer tokens for subsequent API usage by the UI to the system APIs. + +- Hashed passwords are recommended. + +- From the user's browser, reach the Identity Provider's login URL. + +- Access the metadata XML endpoint in the Identity Provider. + +Configuration of SAML SSO is done using API/UI operations but requires configuration both in the user's Identity Provider and within Anchore. + +The Identity Provider must: + +- Support HTTP Redirect binding +- Support signed assertions and signed documents +- Allow unsigned client requests from Anchore +- Allow unencrypted requests and responses + +Click the [link](https://docs.anchore.com/current/docs/overview/sso/) for more Anchore security information. \ No newline at end of file diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md new file mode 100644 index 0000000..b0c779d --- /dev/null +++ b/docs/Troubleshooting.md @@ -0,0 +1,14 @@ +# Troubleshooting Guide + +In this troubleshooting guide, we'll walk through several best-practice techniques to debug Anchore Enterprise. + +- The first recommended approach is to verify that the services are up and running and are in a healthy state. +- The Event Subsystem can be utilized to identify issues. +- Explore the event logs +- Remove Repositories or Images + + +For more Anchore Enterprise troubleshooting information click [here](https://docs.anchore.com/current/docs/troubleshooting/). + + + diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..75c0b31 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,44 @@ +# Anchore Enterprise + +Anchore Enterprise provides container inspection and compliance solutions. It protects against internal and external threats, enforces +security best practices, and speed up DevSecOps workflows. Anchore Enterprise integrates seamlessly to enforce defined polices. + + +Anchore Enterprises can be installed using the [Helm Chart](https://github.com/anchore/anchore-charts/tree/master/stable/anchore-engine), integrated into container based CI/CD +pipeline with a [Jenkins Plugin](https://plugins.jenkins.io/anchore-container-scanner/), and used with the GitLab CI pipelines with the [GitLab integration guide](https://docs.anchore.com/current/docs/using/integration/ci_cd/gitlab/). + +### Anchore Software Components + +- On-premises Anchore Enterprise + - Web UI + - API + - Notifications + - RBAC + - Reporting + - Worker + - Queue + - Catalog + - CLI + +- On-premises Feed Service + - Enterprise UI + - Anchore CLI + - Jenkins Plugin + - CI Integration + - Enterprise RBAC + - Anchore Engine + +### Quickstart + +- [Docker Compose File](https://docs.anchore.com/current/docs/quickstart/docker-compose.yaml) +- [Prometheus Configuration for Monitoring](https://docs.anchore.com/current/docs/quickstart/anchore-prometheus.yml) + - [Enabling Prometheuse](https://docs.anchore.com/current/docs/quickstart/#optional-enabling-prometheus-monitoring) +- [Swagger UI Nginx Proxy](https://docs.anchore.com/current/docs/quickstart/anchore-swaggerui-nginx.conf) + - [Enabling Swagger](https://docs.anchore.com/current/docs/quickstart/#optional-enabling-swagger-ui) + +### More Topics + +- [Security]() +- [Troubleshooting]() + +Find more information on Anchore Enterprise [here](https://docs.anchore.com/current/docs/overview/). \ No newline at end of file -- GitLab