BDSM Project ~ SM Framework ~

Transcription

1 BDSM Project ~ SM Framework ~

2 BDSM Project The BDSM Project encompasses several sub projects, the one we are concerned about for this presentation is the SM Framework. The BDSM project are about system domination; You are the master, not the systems.

3 SM Framework? ~ S{ystem,tack,cripting} Management Framework Acronyms? Yes Acronyms. A single name or meaning does not accurately describe the project and/or framework. Acronyms were invented to fix this issue :)

4 ~ Not what the framework does ~ It is not about what your framework *does*

5 ~ What the framework enables ~ It is about what it enables. Zen, baby.

6 /opt/sm Core CLI SM core provides a command line interface to your extensions

7 Modules Core CLI SM core also provides modules for your extensions

8 Modules API Core CLI SM core modules have a well defined API that is exposed to your extensions, if they are written using shell language

9 Extensions Core CLI Extensions plug into the core and are exposed through the CLI namespaced using the extension name

10 Extensions Let us talk about the concept of extensions in more detail

11 Extensions {name}/ Extensions are, fundamentally, a directory, which has a name. The name of this directory is the extensions name.

12 Extensions {name}/ bin/ {executables} Language Agnostic Within the extension directory is a bin/ directory which contains any number of files, either script or binary, that are executable by a system. *any* script or binary files. This means that extensions are language agnostic, any language or binary format that is runnable by the system the extension is installed to will work.

13 Language Agnostic ~ however ~ Shell has Advantages! Yes, Really!

14 Extensions {name}/ bin/ shell/ Shell Scripting You may write extension actions using shell scripts. Supporting shell files are stored in the shell/ subdirectory.

15 Extensions {name}/ bin/ shell/ functions Shell Functions Within the shell subdirectory a file called functions can be placed, any functions that are stored within this file are made available to any action files that are shell scripts in the bin/ directory.

16 Modules API Extensions Core CLI Extensions are exposed through the CLI and may load Modules and use module api's. Let us explore a bit more about the modules API.

17 Extensions {name}/ bin/ shell/ functions includes Include Module APIs Within the shell subdirectory a file called includes can be placed; Any module APIs to be loaded may be placed within the includes file. For example api/files, api/paths or api/os.

18 Extensions {name}/ bin/ shell/ functions includes config/ templates/ Depending on Modules Included Modules may use other auxiliary directories that allow you to alter the behavior of the modules.

19 Extensions {name}/ bin/ shell/ functions includes config/ templates/ map CLI mappings Extensions with shell functions defined may also utilize the CLI map file; This file allows us to map CLI actions directly to shell functions instead of action scripts in the bin directory.

20 Extensions {name}/ bin/ shell/ functions includes config/ templates/ map VERSION Every extension should have a VERSION file with a defined version in order to be a valid extension.

21 $ sm ext install {name} {uri} Extensions can be installed through the core CLI with this command. Notice that any valid URI can be used and the extension name may be specified directly.

22 Modules API Extensions Sets Core CLI Sets of extensions may also be installed. The load order is Modules, extensions then extensions from sets when called through the CLI.

23 $ sm sets install {name} {uri} Extension sets may be installed just like single extensions and follows the same rules.

24 Scope BDSM Project ~ SM Framework OS SM CM Distributed The SM Framework is intended to enable extensions to be developed that effectively and efficiently fit between the OS with it's package manager and the configuration management tool.

25 BDSM Project ~ Repositories: github.com/sm ~ Website: bdsm.beginrescueend.com ~ IRC: #beginrescueend I can not emphasize enough to come talk to us on IRC in the #beginrescueend channel if you are interested in learning about the SM Framework or any other BDSM Project efforts.