-
Notifications
You must be signed in to change notification settings - Fork 526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add GLOSSARY.md #800
Merged
Merged
Add GLOSSARY.md #800
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## Bottlerocket terms | ||
|
||
* [**block-party**](sources/updater/block-party): A library that helps retrieve information about Linux block devices. | ||
* [**bork**](sources/api/bork): A setting generator called by sundog to generate the random seed for updog, determining where the host falls in the update order. | ||
* [**buildsys**](tools/buildsys): A build tool that runs package and image builds inside containers. | ||
cargo-make starts the build of each package, each of which calls buildsys, which in turn starts a Docker-based build using the SDK image. | ||
* [**early-boot-config**](sources/api/early-boot-config): A program run at boot to read platform-specific data, such as EC2 user data, and send requested configuration to the API. | ||
* **gptprio:** A structure of bits in GPT partition headers that specifies priority, tries remaining, and whether the partition booted successfully before. | ||
signpost sets these and GRUB uses them to determine which partition set to boot. | ||
* [**growpart**](sources/growpart): A program used to expand disk partitions upon boot. | ||
* **host containers**: Containers that run in a separate instance of containerd than "user" containers spawned by an orchestrator (e.g. Kubernetes). | ||
Used for system maintenance and connectivity. | ||
* [**host-ctr**](sources/host-ctr): The program started by `[email protected]` for each host container. | ||
Its job is to start the specified host container on the “host” instance of containerd, which is separate from the “user” instance of containerd used for Kubernetes pods. | ||
* [**laika**](sources/preinit/laika): A crate that builds a binary (`/sbin/preinit`) that's used to mount filesystems before starting init (`systemd`). | ||
* [**model**](sources/models): The API system has a data model defined for each variant, and this model is used by other programs to serialize and deserialize requests while maintaining safety around data types. | ||
* [**netdog**](sources/api/netdog): A program called by wicked to retrieve and write out network configuration from DHCP. | ||
* [**pluto**](sources/api/pluto): A setting generator called by sundog to find networking settings required by Kubernetes. | ||
* [**schnauzer**](sources/api/schnauzer): A setting generator called by sundog to build setting values that contain template variables referencing other settings. | ||
* **setting generator**: A binary that generates the default value of a setting. | ||
* [**signpost**](sources/updater/signpost): A program used to manipulate the GPT header of the OS disk; fields in the header are used by GRUB to determine the partition set we should boot from. | ||
* [**storewolf**](sources/api/storewolf): A program that sets up the data store for the API upon boot. | ||
* [**sundog**](sources/api/sundog): A program run during boot that generates any settings that depend on runtime system information. | ||
It finds settings that need generation by way of metadata in the API, and calls helper programs specified by that metadata. | ||
* [**thar-be-settings**](sources/api/thar-be-settings): A program that writes out system configuration files, replacing template variables with settings from the API. | ||
* [**updog**](sources/updater/updog): An update client that interfaces with a specified TUF updates repository to upgrade or downgrade Bottlerocket hosts to different image versions. | ||
|
||
## Non-Bottlerocket terms | ||
|
||
* **k8s**: [Kubernetes](https://kubernetes.io/), a container orchestration system. | ||
* [**CNI**](https://github.com/containernetworking/cni): Container Network Interface, a standard for writing plugins to configure network interfaces in containers. | ||
* **IMDS**: [Amazon EC2's Instance Metadata Service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). | ||
Used to retrieve user and platform configuration on an EC2 instance. | ||
* [**sonobuoy**](https://github.com/vmware-tanzu/sonobuoy): A diagnostic tool and runs Kubernetes conformance tests for Kubernetes clusters. | ||
* **SSM**: [AWS Systems Manager](https://aws.amazon.com/systems-manager/). | ||
The [SSM agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/prereqs-ssm-agent.html) can be used for secure remote management. | ||
* [**tough**](https://crates.io/crates/tough): a Rust implementation of The Update Framework (TUF). | ||
* [**tuftool**](https://crates.io/crates/tuftool): a command line program for interacting with a TUF repo. | ||
* **TUF**: [The Update Framework](https://theupdateframework.io/). | ||
A framework that helps developers maintain the security of software update systems. | ||
* [**wicked**](https://github.com/openSUSE/wicked): A network interface framework and management system. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should link to projects where appropriate.