README
¶
Automate
Automate provides a unified view into infrastructure managed by Chef Infra, 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://docs.chef.io/automate/
- Release Notes: https://docs.chef.io/release_notes_automate/
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
- Opensearch Gateway
- Opensearch 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
Getting Started
Please see Quickstart and Development Basics in the development document.
Architecture
The following picture illustrates the Automate 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
|
|
|
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/cfgmgmt/service
Package service is a generated GoMock package.
|
Package service is a generated GoMock package. |
|
interservice/compliance/ingest/ingest
Package ingest is a generated GoMock package.
|
Package ingest is a generated GoMock package. |
|
interservice/event
Package event is a generated GoMock package.
|
Package event is a generated GoMock package. |
|
interservice/event_feed
Package event_feed is a generated GoMock package.
|
Package event_feed is a generated GoMock package. |
|
interservice/ingest
Package ingest is a generated GoMock package.
|
Package ingest is a generated GoMock package. |
|
interservice/nodemanager/manager
Package manager is a generated GoMock package.
|
Package manager is a generated GoMock package. |
|
interservice/nodemanager/nodes
Package nodes is a generated GoMock package.
|
Package nodes is a generated GoMock package. |
|
interservice/report_manager
Package report_manager is a generated GoMock package.
|
Package report_manager is a generated GoMock package. |
|
scripts
command
|
|
|
external
module
|
|
|
components
|
|
|
authn-service/cmd/authn-service
command
|
|
|
authn-service/cmd/migrate-tokens
command
|
|
|
authz-service/cmd/authz-service
command
|
|
|
automate-cds/cmd/automate-cds
command
|
|
|
automate-cli/cmd/chef-automate
command
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
command
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
command
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
command
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
command
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/cmd/pg_dump
command
|
|
|
automate-deployment/pkg/assets
Generated by agg_bindings.sh.
|
Generated by agg_bindings.sh. |
|
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/services/internal/generated
Code generated by go generate; DO NOT EDIT.
|
Code generated by go generate; DO NOT EDIT. |
|
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/deployment
Package deployment is a reverse proxy.
|
Package deployment is a reverse proxy. |
|
automate-gateway/api/gateway
Package gateway is a reverse proxy.
|
Package gateway 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/notifications
Package notifications is a reverse proxy.
|
Package notifications is a reverse proxy. |
|
automate-gateway/api/scripts
command
|
|
|
automate-gateway/api/telemetry
Package telemetry is a reverse proxy.
|
Package telemetry is a reverse proxy. |
|
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-grpc/protoc-gen-policy
command
|
|
|
automate-platform-tools/cmd/pg-helper
command
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
command
secrets-helper: a chef_secrets-compatible secrets helper.
|
secrets-helper: a chef_secrets-compatible secrets helper. |
|
event-gateway/cmd/event-gateway
command
|
|
|
event-service/cmd/event-service
command
|
|
|
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. |
|
license-control-service/pkg/keys
Code generated by tools/gen-keys.
|
Code generated by tools/gen-keys. |
|
local-user-service/cmd/users
command
|
|
|
local-user-service/users/mock
nolint: govet
|
nolint: govet |
|
notifications-client/cmd
command
|
|
|
teams-service/cmd/teams-service
command
|
|
|
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 |
|
docs-chef-io
module
|
|
|
dev-docs
|
|
|
adding-data
command
|
|
|
examples
command
|
|
|
integration
|
|
|
helpers/loadbalancer
command
|
|
|
helpers/requestbin
command
|
|
|
lib
|
|
|
license
package license provides functions for reading and printing licenses generated by Chef's license generation service.
|
package license provides functions for reading and printing licenses generated by Chef's license generation service. |
|
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/pg
Code generated by mockery v1.0.0.
|
Code generated by mockery v1.0.0. |
|
platform/sys
Package platform encapsulates platform-specific behavior.
|
Package platform encapsulates platform-specific behavior. |
|
product
Package product provides the description and parser for the top-level product.meta file and the package.meta files that can be provided for individual components.
|
Package product provides the description and parser for the top-level product.meta file and the package.meta files that can be provided for individual components. |
|
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. |
|
timef
time format, time calculation, all time related things.
|
time format, time calculation, all time related things. |
|
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
|
|
|
bldr-config-gen
command
|
|
|
builder-scaffolding
command
|
|
|
cereal-scaffold
command
|
|
|
credscan
command
|
|
|
danger-delete-ds-certs
command
|
|
|
dev-cert-gen
command
|
|
|
hab-bug-6252-repro
command
|
|
|
hab-dep-graph
command
|
|
|
print-ds-config
command
|
Click to show internal directories.
Click to hide internal directories.