Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Capitalized Snap in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kjlyon committed Nov 14, 2016
1 parent 87e0440 commit 1163dd8
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ will cover how to contribute code, report issues, build the project and run the

## Contributing Code

Contribution of code to snap is a snap (pun intended):
Contributing code to Snap is a snap (pun intended):
- Fork the project to your own repository
- Create a topic branch from where you want to base your work (usually master)
- Make commit(s) (following commit guidelines below)
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,19 @@ limitations under the License.
* Allow flexible processing of telemetry data on agent (e.g. filtering and decoration)
* Provide powerful clustered control of telemetry workflows across small or large clusters

The key features of snap are:
The key features of Snap are:

* **Plugin Architecture**: snap has a simple and smart modular design. The three types of plugins (collectors, processors, and publishers) allow snap to mix and match functionality based on user need. All plugins are designed with versioning, signing and deployment at scale in mind. The **open plugin model** allows for loading built-in, community, or proprietary plugins into snap.
* **Plugin Architecture**: Snap has a simple and smart modular design. The three types of plugins (collectors, processors, and publishers) allow Snap to mix and match functionality based on user need. All plugins are designed with versioning, signing and deployment at scale in mind. The **open plugin model** allows for loading built-in, community, or proprietary plugins into Snap.
* **Collectors** - Collectors consume telemetry data. Collectors are built-in plugins for leveraging existing telemetry solutions (Facter, CollectD, Ohai) as well as specific plugins for consuming Intel telemetry (Node, DCM, NIC, Disk) and can reach into new architectures through additional plugins (see [Plugin Authoring below](#author-a-plugin)). Telemetry data is organized into a dynamically generated catalog of available data points.
* **Processors** - Extensible workflow injection. Convert telemetry into another data model for consumption by existing consumption systems (like OpenStack Ceilometer). Allows encryption of all or part of the telemetry payload before publishing. Inject remote queries into workflow for tokens, filtering, or other external calls. Implement filtering at an agent level reducing injection load on telemetry consumer.
* **Publishers** - Store telemetry into a wide array of systems. snap decouples the collection of telemetry from the implementation of where to send it. snap comes with a large library of publisher plugins that allow exposure to telemetry analytics systems both custom and common. This flexibility allows snap to be valuable to open source and commercial ecosystems alike by writing a publisher for their architectures.
* **Publishers** - Store telemetry into a wide array of systems. Snap decouples the collection of telemetry from the implementation of where to send it. Snap comes with a large library of publisher plugins that allow exposure to telemetry analytics systems both custom and common. This flexibility allows Snap to be valuable to open source and commercial ecosystems alike by writing a publisher for their architectures.


* **Dynamic Updates**: snap is designed to evolve. Each scheduled workflow automatically uses the most mature plugin for that step, unless the collection is pinned to a specific version (e.g. get /intel/psutil/load/load1/v1). Loading a new plugin automatically upgrades running workflows in tasks. Load plugins dynamically, without a restart to the service or server. This dynamically extends the metric catalog when loaded, giving access to new measurements immediately. Swapping a newer version plugin for an old one in a safe transaction. All of these behaviors allow for simple and secure bug fixes, security patching, and improving accuracy in production.
* **Dynamic Updates**: Snap is designed to evolve. Each scheduled workflow automatically uses the most mature plugin for that step, unless the collection is pinned to a specific version (e.g. get /intel/psutil/load/load1/v1). Loading a new plugin automatically upgrades running workflows in tasks. Load plugins dynamically, without a restart to the service or server. This dynamically extends the metric catalog when loaded, giving access to new measurements immediately. Swapping a newer version plugin for an old one in a safe transaction. All of these behaviors allow for simple and secure bug fixes, security patching, and improving accuracy in production.

* **Snap tribe**: snap is designed for ease of administration. With snap tribe, nodes work in groups (aka tribes). Requests are made through agreement- or task-based node groups, designed as a scalable gossip-based node-to-node communication process. Administrators can control all snap nodes in a tribe agreement by messaging just one of them. There is auto-discovery of new nodes and import of tasks and plugins from nodes within a given tribe. It is cluster configuration management made simple.
* **Snap tribe**: Snap is designed for ease of administration. With Snap tribe, nodes work in groups (aka tribes). Requests are made through agreement- or task-based node groups, designed as a scalable gossip-based node-to-node communication process. Administrators can control all Snap nodes in a tribe agreement by messaging just one of them. There is auto-discovery of new nodes and import of tasks and plugins from nodes within a given tribe. It is cluster configuration management made simple.

Some additionally important notes about how snap works:
Some additionally important notes about how Snap works:

* Multiple management modules including: [CLI](docs/SNAPCTL.md) (snapctl) and [REST API](docs/REST_API.md) (each of which can be turned on or off)
* Secure validation occurs via plugin signing, SSL encryption for APIs and payload encryption for communication between components
Expand All @@ -88,7 +88,7 @@ Some additionally important notes about how snap works:

### System Requirements

Snap does not have external dependencies since it is compiled into a statically linked binary. At this time, we build snap binaries for Linux and MacOS. We also provide Linux RPM/Deb packages and MacOS X .pkg installer.
Snap does not have external dependencies since it is compiled into a statically linked binary. At this time, we build Snap binaries for Linux and MacOS. We also provide Linux RPM/Deb packages and MacOS X .pkg installer.

### Installation

Expand Down Expand Up @@ -142,7 +142,7 @@ NOTE: If you prefer to build from source, follow the steps in the [build documen

### Running Snap

If you installed snap from RPM/Deb package, you can start/stop Snap daemon as a service:
If you installed Snap from RPM/Deb package, you can start/stop Snap daemon as a service:

RedHat 6/Ubuntu 14.04:
```
Expand All @@ -154,7 +154,7 @@ RedHat 7/Ubuntu 16.04:
$ systemctl start snap-telemetry
```

If you installed snap from binary, you can start Snap daemon via the command:
If you installed Snap from binary, you can start Snap daemon via the command:
```
$ sudo mkdir -p /var/log/snap
$ sudo snapd --plugin-trust 0 --log-level 1 -o /var/log/snap &
Expand Down Expand Up @@ -284,7 +284,7 @@ If you would like to write your own, read through [Author a Plugin](#author-a-pl
## Documentation
Documentation for Snap will be kept in this repository for now with an emphasis of filling out the `docs/` directory. We would also like to link to external how-to blog posts as people write them. [Read about contributing to the project](#contributing) for more details.

* [snapd (snap agent)](docs/SNAPD.md)
* [snapd (Snap agent)](docs/SNAPD.md)
* [configuring snapd](docs/SNAPD_CONFIGURATION.md)
* [snapctl (Snap CLI)](docs/SNAPCTL.md)
* [build and test](docs/BUILD_AND_TEST.md)
Expand Down Expand Up @@ -316,7 +316,7 @@ We have a few known features we want to take on from here while we remain open f
If you would like to propose a feature, please [open an Issue](https://github.com/intelsdi-x/snap/issues)) that includes RFC in it (for [request for comments](https://en.wikipedia.org/wiki/Request_for_Comments)).

## Community Support
This repository is one of **many** projects in the **Snap framework**. Discuss your questions about snap by reaching out to us:
This repository is one of **many** projects in the **Snap framework**. Discuss your questions about Snap by reaching out to us:

* Through GitHub Issues. Issues is our home for **all** needs: Q&A on everything - installation, request for events, integrations, bug issues, futures. [Open up an Issue](https://github.com/intelsdi-x/snap/issues) and know there's no wrong question for us.
* We also have a [Slack team](https://intelsdi-x.herokuapp.com/) where we hang out
Expand Down Expand Up @@ -349,7 +349,7 @@ Snap is Open Source software released under the [Apache 2.0 License](LICENSE).

## Contributors
### Initial Authors
All contributors are equally important to us, but we would like to thank the [initial authors](AUTHORS.md#initial-authors) for helping make open sourcing snap possible.
All contributors are equally important to us, but we would like to thank the [initial authors](AUTHORS.md#initial-authors) for helping make open sourcing Snap possible.

### Maintainers
Amongst the many awesome contributors, there are the maintainers. These maintainers may change over time, but they are all members of the **@intelsdi-x/snap-maintainers** team. This group will help you by:
Expand Down
2 changes: 1 addition & 1 deletion docs/BUILD_AND_TEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The instructions below assume that the `GOPATH` environment variable has been se
Now you can download Snap into your `$GOPATH`:

```
$ # -d is used to download snap without building it
$ # -d is used to download Snap without building it
$ go get -d github.com/intelsdi-x/snap
$ cd $GOPATH/src/github.com/intelsdi-x/snap
```
Expand Down
2 changes: 1 addition & 1 deletion docs/DISTRIBUTED_WORKFLOW_ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Distributed workflow is accomplished by allowing remote targets to be specified

## Performance considerations

The main performance penalty for using remote targets is that data is now sent over the network instead of locally. This is minimized since snap will only make remote calls for steps in the workflow that specify a remote target.
The main performance penalty for using remote targets is that data is now sent over the network instead of locally. This is minimized since Snap will only make remote calls for steps in the workflow that specify a remote target.
2 changes: 1 addition & 1 deletion docs/METRICS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Snap Metrics

A metric in snap has the following fields.
A metric in Snap has the following fields.

* Namespace `[]core.NamespaceElement`
* Uniquely identifies the metric
Expand Down
2 changes: 1 addition & 1 deletion docs/PLUGIN_LIFECYCLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.
-->
# Plugin life cycle

A snap plugin can be in a `Loaded` or `Running` state. A plugin can be loaded
A Snap plugin can be in a `Loaded` or `Running` state. A plugin can be loaded
in the following two ways.

1. `snapd` was started with an auto discover path `snapd -a /etc/snapd/plugins`
Expand Down
6 changes: 3 additions & 3 deletions docs/PLUGIN_PACKAGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Image) format defined in the
[App Container spec (appc)](https://github.com/appc/spec) for packaging a
plugin.

When snap loads a plugin it detects the plugins type. If the plugin is a binary
When Snap loads a plugin it detects the plugins type. If the plugin is a binary
the plugin is run by snapd which handshakes with the plugin via reading its
standard output. If the plugin is packaged as an ACI image it is extracted
and snap executes the program referenced by the `exec` field.
and Snap executes the program referenced by the `exec` field.

## Why

Expand All @@ -31,7 +31,7 @@ loaded the binary version of the plugin.
* Download the latest binary
[release](https://github.com/appc/acbuild/releases) and install into your
PATH.
2. Make snap
2. Make Snap
* From the root of snap run: `make`
4. Using the acbuild tool create an image containing the mock collector plugin.
* From the `build/plugin` directory run the following commands.
Expand Down
4 changes: 2 additions & 2 deletions docs/SNAPCTL.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ $ $SNAP_PATH/bin/snapctl [global options] command [command options] [arguments..
### Global Options
```
--url, -u 'http://localhost:8181' Sets the URL to use [$SNAP_URL]
--insecure Ignore certificate errors when snap's API is running HTTPS
--api-version, -a 'v1' The snap API version
--insecure Ignore certificate errors when Snap's API is running HTTPS
--api-version, -a 'v1' The Snap API version
--password, -p Password for REST API authentication
--config, -c Path to a config file [$SNAPCTL_CONFIG_PATH]
--help, -h show help
Expand Down
10 changes: 5 additions & 5 deletions docs/SNAPD.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,18 @@ $ $SNAP_PATH/bin/snapd [global options] command [command options] [arguments...]
--log-path, -o Path for logs. Empty path logs to stdout. [$SNAP_LOG_PATH]
--log-truncate Log file truncating mode. Default is false => append (true => truncate).
--log-colors Log file coloring mode. Default is true => colored (--log-colors=false => no colors).
--max-procs, -c '1' Set max cores to use for snap Agent. Default is 1 core. [$GOMAXPROCS]
--max-procs, -c '1' Set max cores to use for Snap Agent. Default is 1 core. [$GOMAXPROCS]
--auto-discover, -a Auto discover paths separated by colons. [$SNAP_AUTODISCOVER_PATH]
--max-running-plugins, -m '3' The maximum number of instances of a loaded plugin to run [$SNAP_MAX_PLUGINS]
--plugin-load-timeout '3' The maximum number of seconds a plugin can take to load [$SNAP_PLUGIN_LOAD_TIMEOUT]
--cache-expiration '500ms' The time limit for which a metric cache entry is valid [$SNAP_CACHE_EXPIRATION]
--plugin-trust, -t '1' 0-2 (Disabled, Enabled, Warning) [$SNAP_TRUST_LEVEL]
--keyring-paths, -k Keyring paths for signing verification separated by colons [$SNAP_KEYRING_PATHS]
--rest-cert A path to a certificate to use for HTTPS deployment of snap's REST API
--rest-cert A path to a certificate to use for HTTPS deployment of Snap's REST API
--config A path to a config file
--rest-https start snap's API as https
--rest-key A path to a key file to use for HTTPS deployment of snap's REST API
--rest-auth Enables snap's REST API authentication
--rest-https start Snap's API as https
--rest-key A path to a key file to use for HTTPS deployment of Snap's REST API
--rest-auth Enables Snap's REST API authentication
--work-manager-queue-size "0" Size of the work manager queue (default: 25) [$WORK_MANAGER_QUEUE_SIZE]
--work-manager-pool-size "0" Size of the work manager pool (default 4) [$WORK_MANAGER_POOL_SIZE]
--tribe-node-name 'tjerniga-mac01.local' Name of this node in tribe cluster (default: hostname) [$SNAP_TRIBE_NODE_NAME]
Expand Down
6 changes: 3 additions & 3 deletions docs/SNAPD_CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ This section comprises of configuration settings that are specific for the Snap

```yaml
---
# log_level for the snap daemon. Supported values are
# log_level for the Snap daemon. Supported values are
# 1 - Debug, 2 - Info, 3 - Warning, 4 - Error, 5 - Fatal.
# Default value is 3.
log_level: 3

# log_path sets the path for logs for the snap daemon. By
# log_path sets the path for logs for the Snap daemon. By
# default snapd prints all logs to stdout. Any provided
# path will send snapd logs to a file called snapd.log in
# the provided directory.
Expand All @@ -72,7 +72,7 @@ The control section contains settings for configuring the Control module within
```yaml
control:
# auto_discover_path sets a directory to auto load plugins on the start
# of the snap daemon
# of the Snap daemon
auto_discover_path: /opt/snap/plugins

# cache_expiration sets the time interval for the plugin cache to use before
Expand Down

0 comments on commit 1163dd8

Please sign in to comment.