Mac Maker’s documentation

• Project Overview
  • Mac Maker
    • Generate a consistent, reproducible “profile” of your machine
    • Master Branch Builds
    • Production Branch Builds
  • Quick Start
    • How do I use this?
    • OK, but you still didn’t tell me how to get started…
    • Mac Maker Profiles
• Ensure Python is Installed
  • Monterey and Later
• Using Mac Maker
  • Using the CLI
  • Avoiding a SUDO Prompt
  • Terminating a Stuck Ansible Job
  • Security Considerations
• CLI Summary
  • mac_maker.cli
• CLI Subcommand Reference
  • mac_maker.cli
    • apply
      • github
      • spec
    • precheck
      • github
      • spec
    • version
• Mac Maker Profiles
  • Precheck Metadata
    • Environment Precheck File (env.yml) Specification
  • Galaxy Requirements
  • install.yml Playbook
  • Organizing Your Profile
• Mac Maker Job Spec Files
  • Job Spec File (spec.json) Specification
  • Working With Spec Files
  • An Example Spec File
• Build Instructions
• License
• Codebase
  • mac_maker
    • mac_maker.ansible_controller
      • mac_maker.ansible_controller.environment
        • Environment
          • Environment.setup()
      • mac_maker.ansible_controller.interpreter
        • Interpreter
          • Interpreter.get_interpreter_path()
        • InterpreterNotFound
      • mac_maker.ansible_controller.inventory
        • InventoryFile
          • InventoryFile.write_inventory_file()
      • mac_maker.ansible_controller.process
        • AnsibleProcess
          • AnsibleProcess.spawn()
      • mac_maker.ansible_controller.runner
        • AnsibleRunner
          • AnsibleRunner.start()
      • mac_maker.ansible_controller.tests
        • mac_maker.ansible_controller.tests.test_environment
          • TestEnvironmentClass
            • TestEnvironmentClass.setUp()
        • mac_maker.ansible_controller.tests.test_interpreter
          • TestInterpreter
            • TestInterpreter.setUp()
        • mac_maker.ansible_controller.tests.test_inventory
          • TestInventoryFile
            • TestInventoryFile.setUp()
        • mac_maker.ansible_controller.tests.test_process
          • TestAnsibleProcessClass
            • TestAnsibleProcessClass.setUp()
          • TestAnsibleProcessSpawn
            • TestAnsibleProcessSpawn.setUp()
        • mac_maker.ansible_controller.tests.test_runner
          • TestAnsibleRunnerClass
            • TestAnsibleRunnerClass.setUp()
          • TestAnsibleRunnerSequence
            • TestAnsibleRunnerSequence.setUp()
    • mac_maker.cli
    • mac_maker.config
    • mac_maker.jobs
      • mac_maker.jobs.bases
        • ProvisionerJobBase
          • ProvisionerJobBase.get_precheck_content()
          • ProvisionerJobBase.get_state()
          • ProvisionerJobBase.precheck()
          • ProvisionerJobBase.provision()
        • SimpleJobBase
          • SimpleJobBase.invoke()
      • mac_maker.jobs.filesystem
        • FileSystemJob
          • FileSystemJob.get_precheck_content()
          • FileSystemJob.get_state()
      • mac_maker.jobs.github
        • GitHubJob
          • GitHubJob.get_precheck_content()
          • GitHubJob.get_state()
      • mac_maker.jobs.tests
        • mac_maker.jobs.tests.test_bases
          • MockConcreteJob
            • MockConcreteJob.get_precheck_content()
            • MockConcreteJob.get_state()
          • TestJobsBase
            • TestJobsBase.setUp()
          • TestJobsPrecheck
            • TestJobsPrecheck.setUp()
          • TestJobsProvision
            • TestJobsProvision.setUp()
        • mac_maker.jobs.tests.test_filesystem_job
          • TestFileSystemJob
            • TestFileSystemJob.setUp()
          • TestFileSystemJobGetPrecheck
            • TestFileSystemJobGetPrecheck.setUp()
          • TestFileSystemJobGetStateCase
            • TestFileSystemJobGetStateCase.setUp()
        • mac_maker.jobs.tests.test_github_job
          • TestGitHubJob
            • TestGitHubJob.setUp()
          • TestGitHubJobGetPrecheck
            • TestGitHubJobGetPrecheck.setUp()
          • TestGitHubJobGetState
            • TestGitHubJobGetState.setUp()
        • mac_maker.jobs.tests.test_version
          • TestVersionCommand
            • TestVersionCommand.setUp()
      • mac_maker.jobs.version
        • VersionJob
          • VersionJob.invoke()
    • mac_maker.tests
      • mac_maker.tests.fixtures
        • mac_maker.tests.fixtures.fixtures_git
          • GitTestHarness
            • GitTestHarness.setUp()
        • mac_maker.tests.fixtures.fixtures_spec
          • SpecFileTestHarness
            • SpecFileTestHarness.setUp()
      • mac_maker.tests.test_cli_shell_interrupt
        • TestCommandInterrupt
          • TestCommandInterrupt.setUp()
    • mac_maker.utilities
      • mac_maker.utilities.cli
        • was_started_without_shell()
      • mac_maker.utilities.filesystem
        • FileSystem
          • FileSystem.get_collections_path()
          • FileSystem.get_galaxy_requirements_file()
          • FileSystem.get_inventory_file()
          • FileSystem.get_playbook_file()
          • FileSystem.get_profile_data_path()
          • FileSystem.get_roles_path()
          • FileSystem.get_spec_file()
          • FileSystem.get_work_space_root()
      • mac_maker.utilities.github
        • GithubCommunicationError
        • GithubRepository
          • GithubRepository.download_zip_bundle_profile()
          • GithubRepository.get_branch_name()
          • GithubRepository.get_http_url()
          • GithubRepository.get_org_name()
          • GithubRepository.get_repo_name()
          • GithubRepository.get_ssh_url()
          • GithubRepository.get_zip_bundle_root_folder()
          • GithubRepository.get_zip_bundle_url()
        • InvalidGithubRepository
      • mac_maker.utilities.logger
        • Logger
          • Logger.setup()
      • mac_maker.utilities.mixins
        • mac_maker.utilities.mixins.json_file
          • JSONFileReader
            • JSONFileReader.load_json_file()
          • JSONFileWriter
            • JSONFileWriter.write_json_file()
        • mac_maker.utilities.mixins.tests
          • mac_maker.utilities.mixins.tests.test_json_file
            • JSONFileReaderTest
              • JSONFileReaderTest.setUp()
            • JSONFileWriterTest
              • JSONFileWriterTest.setUp()
          • mac_maker.utilities.mixins.tests.test_text_file
            • TextFileReaderTest
              • TextFileReaderTest.setUp()
            • TextFileWriterTest
              • TextFileWriterTest.setUp()
        • mac_maker.utilities.mixins.text_file
          • TextFileReader
            • TextFileReader.read_text_file()
          • TextFileWriter
            • TextFileWriter.write_text_file()
      • mac_maker.utilities.precheck
        • PrecheckExtractor
          • PrecheckExtractor.get_precheck_data()
        • TypePrecheckFileData
      • mac_maker.utilities.shell
        • CommandLoop
          • CommandLoop.exit()
          • CommandLoop.exit_shell()
          • CommandLoop.interrupt()
          • CommandLoop.patch_interrupt()
      • mac_maker.utilities.spec
        • JobSpecExtractor
          • JobSpecExtractor.get_job_spec_data()
        • TypeSpecFileData
      • mac_maker.utilities.state
        • State
          • State.state_dehydrate()
          • State.state_generate()
          • State.state_rehydrate()
        • TypeState
      • mac_maker.utilities.sudo
        • SUDO
          • SUDO.prompt_for_sudo()
      • mac_maker.utilities.tests
        • mac_maker.utilities.tests.test_cli
          • TestCLIUtilities
        • mac_maker.utilities.tests.test_filesystem
          • TestFileSystem
            • TestFileSystem.setUp()
        • mac_maker.utilities.tests.test_github
          • TestGithubRepositoryGetMethods
            • TestGithubRepositoryGetMethods.setUp()
          • TestGithubRepositoryInitialize
          • TestGithubRepositoryNetwork
            • TestGithubRepositoryNetwork.setUp()
        • mac_maker.utilities.tests.test_precheck
          • TestSpecExtractPreCheckFromJobSpec
            • TestSpecExtractPreCheckFromJobSpec.setUp()
        • mac_maker.utilities.tests.test_spec
          • TestSpecClass
            • TestSpecClass.setUp()
          • TestSpecReadSpecFromFileSystem
            • TestSpecReadSpecFromFileSystem.setUp()
        • mac_maker.utilities.tests.test_state
          • TestStateClass
            • TestStateClass.setUp()
        • mac_maker.utilities.tests.test_sudo
          • MockPopenResponse
          • TestSUDO
            • TestSUDO.setUp()
          • TestSUDOEnv
            • TestSUDOEnv.setUp()
        • mac_maker.utilities.tests.test_workspace
          • TestWorkSpace
            • TestWorkSpace.setUp()
      • mac_maker.utilities.validation
        • mac_maker.utilities.validation.precheck
          • PrecheckConfigValidationException
          • PrecheckConfigValidator
            • PrecheckConfigValidator.validate_config()
            • PrecheckConfigValidator.validate_environment()
          • TypePrecheckEnvironmentValidationResult
          • TypePrecheckVariableDefinition
        • mac_maker.utilities.validation.spec
          • SpecFileValidationException
          • SpecFileValidator
            • SpecFileValidator.validate_spec_file()
          • TypeSpecFileData
        • mac_maker.utilities.validation.tests
          • mac_maker.utilities.validation.tests.test_precheck
            • TestValidateEnv
              • TestValidateEnv.setUp()
              • TestValidateEnv.setUpClass()
            • TestValidator
          • mac_maker.utilities.validation.tests.test_spec
            • TestSpecFileValidatorClass
            • TestSpecValidity
      • mac_maker.utilities.workspace
        • InvalidWorkspace
        • WorkSpace
          • WorkSpace.add_repository()
          • WorkSpace.add_spec_file()

Indices and tables

• Index

• Module Index

• Search Page