An AWS Professional Service open source initiative | aws-proserve-opensource@amazon.com

Seed-Farmer

Seed-Farmer is an opensource orchestration tool that works with AWS CodeSeeder and acts as an orchestration tool modeled after GitOps deployments . It has a CommandLine Interface (CLI) based in Python.

Seed-Farmer leverages modular code deployments (see modules) leveraging manifests and deployspecs, keeping track of changes and applying changes as need / detected.

Contents:

• Overview
  • Multi Account Support
  • Concepts
• Quick Start Guide
  • Prep your Environment
  • Bootstrap Your Account
  • Deploy a Deployment in the Project
  • Destroy a Deployment
• Architecture
  • Multi-Account Architecture
  • Method of Processing
  • AWS CodeSeeder
    • Updating the AWS CodeSeeder Seedkit
• Installation
• Bootstrapping Accounts
  • Bootstrap Toolchain Account
  • Bootstrap Target Account
  • Qualifiers for Toolchain Role and Target Roles
  • Prepping the Account / Region
• Project Development
  • Initialization
    • Permissions Boundary Support
• Manifests
  • Deployment Manifest
    • Network Configuration for Regions
    • Dependency Management
  • Module Manifest
    • A Word About DataFiles
  • Codebuild Image Override
    • AWS Curated Build Images
    • Custom Build Images
    • Logic for Rules – Application
  • Mirror Overrides
  • Parameters
    • User-Defined
    • Environment Variables
    • Module Metadata
    • Global and Regional Parameters
    • AWS SSM Parameter
    • AWS SecretsManager
    • Docker Credentials Secret
    • Parameters in AWS CodeSeeder
• CLI (Command Line Interface)
  • HTTP Proxy Support
  • Summary of Commands
    • seedfarmer apply
    • seedfarmer destroy
    • seedfarmer list dependencies
    • seedfarmer list deployspec
    • seedfarmer list moduledata
    • seedfarmer list allmoduledata
    • seedfarmer list modules
    • seedfarmer list deployments
    • seedfarmer list buildparams
    • seedfarmer list schema
    • seedfarmer bootstrap toolchain
    • seedfarmer bootstrap target
    • seedfarmer init module
    • seedfarmer init project
    • seedfarmer projectpolicy synth
    • seedfarmer metadata convert
    • seedfarmer metadata add
    • seedfarmer metadata depmod
    • seedfarmer metadata paramvalue
    • seedfarmer remove moduledata
    • seedfarmer store deployspec
    • seedfarmer store moduledata
    • seedfarmer store md5
• Module Development
  • Required Files
  • Optional Files
  • Create a new module
  • Deployspec
    • Structure
    • Deployspec Parameters of Interest
    • Deployspec CLI Helper Commands
  • Module ReadMe
    • Example
  • ModuleStack
    • Initial Template
    • Parameters
  • Add the Manifests
• Deployment Step-By-Step
  • Create a Virtual environment
  • Install the requirements
  • Bootstrap the Toolchain and Target Accounts
  • Bootstrap the CDK in Each Account/Region
  • Create a New Project or Clone Existing
  • Add Dockerhub Support if needed
  • Create New Project
  • Create Modules
  • Deploy Modules
  • Destroy Modules
  • Destroy Deployment
• Best Practices
  • Ordering of Module Deployment
  • Preferred Build Tooling
  • When to use a modulestack.yaml policy
  • Validation of Module Code
    • fix.sh
    • validate.sh
• Templating with Cookiecutter
  • What is Cookiecutter
  • SeedFarmer and Cookiecutter
    • Create the Module Skeleton
• Frequently Asked Questions
  • How do SeedFarmer and AWS CodeSeeder work together?
• API Reference
  • seedfarmer
    • Subpackages
    • Submodules
    • Package Contents

Indices and tables

• Index

• Module Index

• Search Page