Skip to main content

An Ansible kernel for Jupyter

Project description

# Ansible Jupyter Kernel

![Example Jupyter Usage](https://raw.githubusercontent.com/ansible/ansible-jupyter-kernel/master/docs/example_session.png)

The Ansible [Jupyter](http://jupyter.readthedocs.io/en/latest/) Kernel adds a kernel backend for Jupyter to interface directly with Ansible and construct plays and tasks and execute them on the fly.

## Table of Contents

* [Installation](#installation)
* [From pypi](#from-pypi)
* [From a local checkout](#from-a-local-checkout)
* [Usage](#usage)
* [Using the cells](#using-the-cells)
* [Examples](#examples)
* [Using the development environment](#using-the-development-environment)

## Installation:

`ansible-kernel` is available to be installed from pypi but you can also install it locally. The setup package itself will register the kernel
with `Jupyter` automatically.

### From pypi

pip install ansible-kernel

### From a local checkout

pip install -e .

## Usage

```
jupyter notebook
# In the notebook interface, select Ansible from the 'New' menu
```

### Using the Cells

Normally `Ansible` brings together various components in different files and locations to launch a playbook and performs automation tasks. For this
`jupyter` interface you need to provide this information in cells by denoting what the cell contains and then finally writing your tasks that will make
use of them. There are [Examples](#examples) available to help you, in this section we'll go over the currently supported cell types.

In order to denote what the cell contains you should prefix it with a pound/hash symbol (#) and the type as listed here as the first line as shown in the examples
below.

#### #inventory

The inventory that your tasks will use

```
#inventory
[all]
ahost ansible_connection=local
anotherhost examplevar=val
```

#### #play

This represents the opening block of a typical `Ansible` play

```
#play
name: Hello World
hosts: all
gather_facts: false
```

#### #task

This is the default cell type if no type is given for the first line

```
#task
debug:
```

```
#task
shell: cat /tmp/afile
register: output
```

#### #host_vars

#### #group_vars

#### #vars

This takes an argument that represents the filename for use in later cells

```
#vars example_vars
message hello vars
```

```
#play
name: hello world
hosts: localhost
gather_facts: false
vars_files:
- example_vars
```

#### #template

This takes an argument in order to create a templated file that can be used in later cells

```
#template hello.j2
{{ message }}
```

```
#task
template:
src: hello.j2
dest: /tmp/hello
```

#### #ansible.cfg

Provides overrides typically found in ansible.cfg

```
#ansible.cfg
[defaults]
host_key_checking=False
```

### Examples

You can find various [example notebooks in the repository](https://github.com/ansible/ansible-jupyter-kernel/tree/master/notebooks)

## Using the development environment

It's possible to use whatever python development process you feel comfortable with. The repository itself includes mechanisms for
using [pipenv](https://github.com/pypa/pipenv)

```
pipenv install
...
pipenv shell
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible-kernel-0.3.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

ansible_kernel-0.3-py2.py3-none-any.whl (28.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ansible-kernel-0.3.tar.gz.

File metadata

  • Download URL: ansible-kernel-0.3.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ansible-kernel-0.3.tar.gz
Algorithm Hash digest
SHA256 38ed8dc9404d59f893dd8c2fef9c11d4a83d520392587a81f59c60dc86c2920d
MD5 7e2876edc9e6dc77d6cb0f53e17c16b7
BLAKE2b-256 087d82a2ddf0ea6afd39ccff87496d1c403c588c6a0f2edcddc510c3a54b1129

See more details on using hashes here.

File details

Details for the file ansible_kernel-0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ansible_kernel-0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b604cd9fe452ec62b8aabd7753b00b6ffdadde3208378052b191cc333c460451
MD5 850017823f9f7026f7789b80d277afd5
BLAKE2b-256 32d54e198d2e3b884aebd09f925610f6af63f03c76d42721b775d59a6a2f16c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page