Sha256: e82322bdb7e0f9e8a4ddf840b239144da51e282e7707cbb5dd1a1f9ef5caf484

Contents?: true

Size: 1.4 KB

Versions: 22

Compression:

Stored size: 1.4 KB

Contents

---
title: "Configuration"
weight: 2
anchors:
  - title: "sfn-based"
    url: "#sfn-based"
  - title: "knife-based"
    url: "#knife-based"
  - title: "Generate sfn configuration"
    url: "#generate-sfn-configuration"
  - title: "configuration-options"
    url: "#configuration-options"
---


## Configuration

The configuration location of the `sfn` command is
dependent on the invocation method used. Since the
CLI application can be invoked as a standalone
application, or as a knife subcommand, two styles
of configuration are supported.

### `sfn`-based

Configuration for the `sfn` standalone application
utilizes the bogo-config library. This allows the
configuration file to be defined in multiple formats.
Supported formats:

* Ruby
* YAML
* JSON
* XML

The configuration is contained within a file named
`.sfn`.

#### Generate sfn configuration

The `sfn` command provides a `conf` subcommand. By
default this command will display current local
configuration values. It can also be used to generate
an initial configuration file which can then be
customized:

~~~
$ sfn conf --generate
~~~

This will create a new `.sfn` file in the working directory.

### `knife`-based

The `sfn` application includes a plugin for the
[knife][knife] CLI tool. Configuration can be
provided in the `.chef/knife.rb` file and commands
can be accessed via:

~~~
$ knife sparkleformation --help
~~~

[knife]: https://docs.chef.io/knife.html

Version data entries

22 entries across 22 versions & 1 rubygems

Version Path
sfn-3.1.8 docs/configuration.md
sfn-3.1.6 docs/configuration.md
sfn-3.1.4 docs/configuration.md
sfn-3.1.2 docs/configuration.md
sfn-3.1.0 docs/configuration.md
sfn-3.0.32 docs/configuration.md
sfn-3.0.30 docs/configuration.md
sfn-3.0.28 docs/configuration.md
sfn-3.0.26 docs/configuration.md
sfn-3.0.24 docs/configuration.md
sfn-3.0.22 docs/configuration.md
sfn-3.0.20 docs/configuration.md
sfn-3.0.18 docs/configuration.md
sfn-3.0.16 docs/configuration.md
sfn-3.0.14 docs/configuration.md
sfn-3.0.12 docs/configuration.md
sfn-3.0.10 docs/configuration.md
sfn-3.0.8 docs/configuration.md
sfn-3.0.6 docs/configuration.md
sfn-3.0.4 docs/configuration.md