README
¶
Automate
Automate provides a unified view into infrastructure managed by Chef, Inspec, and Habitat.
Key features include:
- Aggregation and analysis tools for Chef Client and Chef Server data,
- Compliance history and reporting, and
- Compliance scanning of both individual servers and cloud APIs.
For more information see:
- Documentation: https://automate.chef.io/docs/
- Release Notes: https://automate.chef.io/release-notes/
Project State: Active
Issues Response Time Maximum: 5 business days
Pull Request Response Time Maximum: 5 business days
Components
Chef Automate is a collection of microservices. Each service is developed independently.
Core Applications
- Automate UI
- Automate Gateway
- Config Management Service
- Compliance Service
- Event Service
- Ingest Service
- Nodemanager Service
- Notifications Service
Authentication, Authorization, & Administration
- AuthN Service
- AuthZ Service
- Automate-Load-Balancer
- Dex (OpenID Connect)
- Local User Service
- Teams Service
- Session Service
Management and Backend Services
- Backup Gateway
- Data Lifecycle Service
- Deployment Service
- Elasticsearch Gateway
- Elasticsearch Sidecar
- License Control Service
- PostgreSQL Gateway
- PostgreSQL Sidecar
- Secrets Service
- Trial License Service
Optional Additional Components
These components allow you to deploy other Chef projects as part of Automate
-
Chef Server
-
Chef Workflow (in-development)
Getting Started
Please see Quickstart and Development Basics in the development document.
Architecture
The following picture illustrates the Automate 2.0 architecture
API Compatibility
At this stage in development, the Go libraries and other APIs found in this repository are not intended for use outside of Chef Automate. If you think part of this repository would help and would like to depend on it, please open a GitHub issue so we can discuss it.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
external/applications
Package applications is a reverse proxy.
|
Package applications is a reverse proxy. |
|
external/cfgmgmt
Package cfgmgmt is a reverse proxy.
|
Package cfgmgmt is a reverse proxy. |
|
external/ingest
Package ingest is a reverse proxy.
|
Package ingest is a reverse proxy. |
|
external/secrets
Package secrets is a reverse proxy.
|
Package secrets is a reverse proxy. |
|
interservice/authn
Package authn is a generated GoMock package.
|
Package authn is a generated GoMock package. |
|
interservice/authz
Package authz is a generated GoMock package.
|
Package authz is a generated GoMock package. |
|
interservice/authz/v2
Package v2 is a generated GoMock package.
|
Package v2 is a generated GoMock package. |
|
interservice/cfgmgmt/service
Package service is a generated GoMock package.
|
Package service is a generated GoMock package. |
|
interservice/event
Package event is a generated GoMock package.
|
Package event is a generated GoMock package. |
|
interservice/ingest
Package ingest is a generated GoMock package.
|
Package ingest is a generated GoMock package. |
|
components
|
|
|
automate-cli/cmd/chef-automate
package main contains all the logic for parsing command line options/arguments using Cobra.
|
package main contains all the logic for parsing command line options/arguments using Cobra. |
|
automate-cli/pkg/docs
This file was originally part of cobra/doc and has the following license:
|
This file was originally part of cobra/doc and has the following license: |
|
automate-cli/pkg/status
Package status handles chef-automate CLI errors
|
Package status handles chef-automate CLI errors |
|
automate-cs-nginx/cmd/chef-server-ctl
chef-server-ctl: A minimal wrapper for chef-server-ctl
|
chef-server-ctl: A minimal wrapper for chef-server-ctl |
|
automate-cs-oc-erchef/cmd/init-es
init-es creates an elasticsearch index from the given configuration file.
|
init-es creates an elasticsearch index from the given configuration file. |
|
automate-deployment/cmd/automate-ctl
automate-ctl is a FAKE version of automate v1's management CLI tool.
|
automate-ctl is a FAKE version of automate v1's management CLI tool. |
|
automate-deployment/cmd/chef-server-ctl
chef-server-ctl is a FAKE version of Chef Server (omnibus)'s management CLI tool.
|
chef-server-ctl is a FAKE version of Chef Server (omnibus)'s management CLI tool. |
|
automate-deployment/pkg/certauthority
Package certauthority generates and manages x509 certificates for use in cross-service authentication.
|
Package certauthority generates and manages x509 certificates for use in cross-service authentication. |
|
automate-deployment/pkg/client
Package client contains all the business logic of the command line deployment tool.
|
Package client contains all the business logic of the command line deployment tool. |
|
automate-deployment/pkg/events
Since we aren't using the errors from this, we get lots of unparam violations as well
|
Since we aren't using the errors from this, we get lots of unparam violations as well |
|
automate-deployment/pkg/habapi
Package habapi provides access to the Habitat supervisor's HTTP API
|
Package habapi provides access to the Habitat supervisor's HTTP API |
|
automate-deployment/pkg/persistence/boltdb
Package boltdb provides an implementation of DeploymentStore that uses boltdb.
|
Package boltdb provides an implementation of DeploymentStore that uses boltdb. |
|
automate-deployment/pkg/target
Package target encapsulates all the ways we will interact with deployment targets, starting with a client/target to control the hab supervisor locally
|
Package target encapsulates all the ways we will interact with deployment targets, starting with a client/target to control the hab supervisor locally |
|
automate-gateway/api/auth/teams
Package teams is a reverse proxy.
|
Package teams is a reverse proxy. |
|
automate-gateway/api/auth/tokens
Package tokens is a reverse proxy.
|
Package tokens is a reverse proxy. |
|
automate-gateway/api/auth/users
Package users is a reverse proxy.
|
Package users is a reverse proxy. |
|
automate-gateway/api/authz
Package authz is a reverse proxy.
|
Package authz is a reverse proxy. |
|
automate-gateway/api/compliance/profiles
Package profiles is a reverse proxy.
|
Package profiles is a reverse proxy. |
|
automate-gateway/api/compliance/reporting
Package reporting is a reverse proxy.
|
Package reporting is a reverse proxy. |
|
automate-gateway/api/compliance/reporting/stats
Package stats is a reverse proxy.
|
Package stats is a reverse proxy. |
|
automate-gateway/api/compliance/scanner/jobs
Package jobs is a reverse proxy.
|
Package jobs is a reverse proxy. |
|
automate-gateway/api/deployment
Package deployment is a reverse proxy.
|
Package deployment is a reverse proxy. |
|
automate-gateway/api/event_feed
Package event_feed is a reverse proxy.
|
Package event_feed is a reverse proxy. |
|
automate-gateway/api/gateway
Package gateway is a reverse proxy.
|
Package gateway is a reverse proxy. |
|
automate-gateway/api/iam/v2beta
Package v2beta is a reverse proxy.
|
Package v2beta is a reverse proxy. |
|
automate-gateway/api/legacy
Package legacy is a reverse proxy.
|
Package legacy is a reverse proxy. |
|
automate-gateway/api/license
Package license is a reverse proxy.
|
Package license is a reverse proxy. |
|
automate-gateway/api/nodes
Package nodes is a reverse proxy.
|
Package nodes is a reverse proxy. |
|
automate-gateway/api/nodes/manager
Package manager is a reverse proxy.
|
Package manager is a reverse proxy. |
|
automate-gateway/api/notifications
Package notifications is a reverse proxy.
|
Package notifications is a reverse proxy. |
|
automate-gateway/api/telemetry
Package telemetry is a reverse proxy.
|
Package telemetry is a reverse proxy. |
|
automate-gateway/authz/policy_v2
policy_v2 is a copy of the v1 policy code from components/automate-gateway/api/authz/policy/policy.go
|
policy_v2 is a copy of the v1 policy code from components/automate-gateway/api/authz/policy/policy.go |
|
automate-gateway/gateway_mocks/mock_compliance_ingest
Package mock_compliance_ingest is a generated GoMock package.
|
Package mock_compliance_ingest is a generated GoMock package. |
|
automate-gateway/gateway_mocks/mock_feed
Package mock_automate_feed is a generated GoMock package.
|
Package mock_automate_feed is a generated GoMock package. |
|
automate-gateway/gateway_mocks/mock_gateway
Package mock_gateway is a generated GoMock package.
|
Package mock_gateway is a generated GoMock package. |
|
automate-gateway/gateway_mocks/mock_notifier
Package mock_notifier is a generated GoMock package.
|
Package mock_notifier is a generated GoMock package. |
|
automate-platform-tools/cmd/pg-helper
pg-helper: A command-line utility to call p-sidecar-service RPC's to perform database operations.
|
pg-helper: A command-line utility to call p-sidecar-service RPC's to perform database operations. |
|
automate-platform-tools/cmd/secrets-helper
secrets-helper: a chef_secrets-compatible secrets helper.
|
secrets-helper: a chef_secrets-compatible secrets helper. |
|
compliance-service/api/automate-feed/server
Author:: Gina Peers <gpeers@chef.io>, Salim Afiune <afiune@chef.io> Copyright:: Copyright 2018, Chef Software Inc.
|
Author:: Gina Peers <gpeers@chef.io>, Salim Afiune <afiune@chef.io> Copyright:: Copyright 2018, Chef Software Inc. |
|
compliance-service/ingest/ingest
Package ingest is a reverse proxy.
|
Package ingest is a reverse proxy. |
|
ingest-service/serveropts
Configuration options for the ingest service's GRPC and REST servers.
|
Configuration options for the ingest service's GRPC and REST servers. |
|
local-user-service/users/mock
nolint: govet
|
nolint: govet |
|
nodemanager-service/api/manager
Package manager is a generated GoMock package.
|
Package manager is a generated GoMock package. |
|
trial-license-service/pkg/license
Package license makes HTTP requests to a license generation service to obtain trial licenses
|
Package license makes HTTP requests to a license generation service to obtain trial licenses |
|
dev-docs
|
|
|
integration
|
|
|
lib
|
|
|
license
Package license is a generated protocol buffer package.
|
Package license is a generated protocol buffer package. |
|
logger
Package logger is intended to abstract our concrete logging backend, to not litter all the code base with "sirupsen/logrus" imports; also makes it easier to eventually switch out the logging library.
|
Package logger is intended to abstract our concrete logging backend, to not litter all the code base with "sirupsen/logrus" imports; also makes it easier to eventually switch out the logging library. |
|
platform/command
Package command is a wrapper for os/exec that provides a mock-able interface to make testing easier.
|
Package command is a wrapper for os/exec that provides a mock-able interface to make testing easier. |
|
platform/sys
Package platform encapsulates platform-specific behavior.
|
Package platform encapsulates platform-specific behavior. |
|
secrets
The secrets package provides methods for generate, storing, and retrieving secrets data.
|
The secrets package provides methods for generate, storing, and retrieving secrets data. |
|
uuid4
uuid4 wraps github.com/gofrs/uuid in a way that enforces version 4
|
uuid4 wraps github.com/gofrs/uuid in a way that enforces version 4 |
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.