chef / chef/chef-web-docs

Update Airgap Documentation

Open
#2,444 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Component: Chef Infra Server
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

Airgap Documentation

The objective of this documentation is to present setting up Chef in an air gap environment in a realistic way for our (usually large) arigap customers.

What our air gap customers need:
The ability to run our suite securely
The ability to run installations without disruption from external changes (gem yanked, etc)
The ability to upgrade to modern Chef
The ability to set up and run their system in modern Chef

Out of scope:
Setting up a gem mirror
Setting up an artifact store
Process for going from internet connected to air gap

Base Case:

Install Chef Workstation
Install Automate
With Chef Infra Server
Configure Chef Server and get Keys
Bootstrap Chef Client
Requirement; Get Chef Client into Artifact Store
Requirement: Hide Supermarket in Policyfile
Configure Knife or Policyfile
Example config file (knife-bootstrap, examples of scripts, validator-bootstrap with example)
Traditional
Effortless is variation

Development Flow
- Write & Test cookbook locally
- Set up test kitchen
- Get the test kitchen boxes onto system
- VirtualBox
- Vagrant
- Get VMs into artifact store
- Get Chef Client onto box

- Upload
- Deploy

Stand up private Supermarket
Policyfiles

Next Steps:
1. Flow Chart

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the listed base case and development flow, then define the requested flow chart while excluding the stated out-of-scope topics. Done means the air-gap setup, development flow, Policyfiles, and private Supermarket guidance are documented for the described customers.

Written by the indexing model from the issue text.

Assessment

Domain
devops, documentation, infrastructure
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.