-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Rewrite the explanation section
This PR add the explanation of Pebble and rewrite chisel,rocks and overlay-step explanation. Co-authored-by: Cristovao Cordeiro <[email protected]>
- Loading branch information
Samir Akarioh
committed
Jul 25, 2023
1 parent
bdf6451
commit d142dc1
Showing
7 changed files
with
108 additions
and
73 deletions.
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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 |
---|---|---|
|
@@ -14,3 +14,4 @@ the motivations behind its development. | |
chisel | ||
overlay-step | ||
rocks | ||
pebble |
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
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,36 @@ | ||
.. _pebble_explanation_page: | ||
|
||
Pebble | ||
====== | ||
|
||
Pebble is a service manager that helps to organise a set of local service | ||
processes. | ||
|
||
When creating container images, several issues can be met. | ||
For instance, if the entrypoint relies on the application mode | ||
(such as nginx and nginx-debug), creating a bash script that parses all the | ||
arguments provided during container deployment will be necessary. | ||
Additionally, each image runs with specific application arguments, | ||
making it challenging to perform an inspection inside the image consistently. | ||
|
||
Pebble solves these problems by providing a comprehensive set of commands | ||
for starting, stopping, and viewing service status. It also includes features | ||
like auto-restart for continuous operation and dependency management for | ||
properly sequencing services. Pebble streamlines service management as a | ||
single binary that operates as a background service and a client. | ||
|
||
In ROCKs, Pebble services are defined with properties such as name, command, | ||
startup behaviour, dependencies,... Moreover, Pebble is the default entrypoint | ||
(an executable that runs when the container is initiated) in ROCKs, ensuring | ||
consistent container inspection and permit to have multiple entrypoint | ||
without the need to create other files. | ||
|
||
|
||
Create a service | ||
---------------- | ||
|
||
See :doc:`/how-to/convert-to-pebble-layer` for information about converting | ||
a Docker entrypoint to a pebble service. Also, check the top-level field | ||
on :doc:`/reference/rockcraft.yaml` to understand the parameters and fields | ||
needed to create a service. | ||
|
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