Metadata-Version: 2.4
Name: aap-demo
Version: 2.0.0.dev2
Summary: Deploy Ansible Automation Platform 2.7 to OpenShift Local (MicroShift or OpenShift preset)
Project-URL: Homepage, https://github.com/RedHatOfficial/aap-demo
Project-URL: Source, https://github.com/RedHatOfficial/aap-demo
Author: Red Hat
License: Apache-2.0
License-File: LICENSE
Keywords: aap,ansible,crc,microshift,openshift
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Requires-Dist: argcomplete>=3.0
Requires-Dist: jsonschema>=4.0
Requires-Dist: keyring>=24.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Provides-Extra: desktop
Requires-Dist: fastapi>=0.110; extra == 'desktop'
Requires-Dist: toga>=0.4.7; extra == 'desktop'
Requires-Dist: uvicorn>=0.29; extra == 'desktop'
Provides-Extra: dev
Requires-Dist: commitizen; extra == 'dev'
Requires-Dist: mypy<2,>=1.19.1; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: types-jsonschema; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Provides-Extra: gui
Requires-Dist: fastapi>=0.110; extra == 'gui'
Requires-Dist: uvicorn>=0.29; extra == 'gui'
Description-Content-Type: text/markdown

# AAP Demo

Ansible Automation Platform, on your own computer, for demos and trying things out.

This is a local tool. Do not use it for a real production system. The published command is a beta,
version **2.0.0.dev2**. A finished 2.0.0 release is not out yet.

## Start

Here is the short path from a new computer to a page you can open.

You will need three things:

- Python 3.9 or newer, and [pipx](https://pipx.pypa.io/). pipx keeps this
  command in its own corner, away from your other Python tools.
- [OpenShift Local](https://console.redhat.com/openshift/create/local), so you
  have the `crc` command, plus `kubectl`.
- A pull secret from the
  [Red Hat console](https://console.redhat.com/openshift/install/pull-secret).
  The cluster uses it to download Red Hat images.

[Install](docs/guides/install.md) has more on getting the command and updating it.

Save the pull secret in the folder the command checks:

```bash
mkdir -p ~/.config/aap-demo
cp ~/Downloads/pull-secret.txt ~/.config/aap-demo/pull-secret.txt
```

A file named `pull-secret.json` in that same folder also works. To keep it somewhere else, see
[Save your pull secret](docs/guides/first-deploy.md#1-save-your-pull-secret).

Give the machine about 8 processors and 24 GB of memory. The first `create`
builds a virtual machine, so give it a few quiet minutes. Smaller sizes, and
the extra Linux packages, are in [First deploy](docs/guides/first-deploy.md).

Install the command, build the cluster, and install Ansible Automation Platform:

```bash
pipx install aap-demo
aap-demo create
aap-demo deploy
aap-demo status
```

`create` builds the local cluster. `deploy` installs Ansible Automation Platform.
`status` prints the web address and the admin password. [First deploy](docs/guides/first-deploy.md)
walks through each step.

To try AAP 2.6 instead of the usual 2.7 release:

```bash
aap-demo deploy --channel stable-2.6
```

With no `--channel` flag, `deploy` uses the default channel, `stable-2.7`. See
[Choose a version](docs/guides/choose-a-version.md).

Open the address `status` prints and sign in with the admin password on that
screen.

AAP runs without a subscription, but it needs one before it can add hosts. Nothing
is applied unless you choose to. [Subscription](docs/guides/subscription.md) shows
how to apply one, by signing in to AAP or by giving `aap-demo` a manifest file.

 `aap-demo version` should print `2.0.0.dev2`.

Tomorrow, `aap-demo start` turns the cluster on and `aap-demo stop` turns it
off. [Daily use](docs/guides/daily-use.md) covers later days, including a page
that will not load.

## Guides

| I want to… | Read this |
| --- | --- |
| Install or update the command | [Install](docs/guides/install.md) |
| Put a cluster and AAP on this computer | [First deploy](docs/guides/first-deploy.md) |
| Choose AAP 2.6 or 2.7 | [Choose a version](docs/guides/choose-a-version.md) |
| Apply a subscription to AAP | [Subscription](docs/guides/subscription.md) |
| Start, stop, and check on it later | [Daily use](docs/guides/daily-use.md) |
| Add demo machines or other extras | [Add-ons](docs/guides/addons.md) |
| Keep using a feature the new command does not have yet | [The older command](docs/guides/older-command.md) |

## Look something up

| | |
| --- | --- |
| Every command | [Commands](docs/reference/commands.md) |
| Memory, disk, and where files are saved | [Settings](docs/reference/settings.md) |
| A copy-paste first run | [Example: first cluster](docs/examples/first-cluster.md) |

## About this project

- [What aap-demo is](docs/concepts/what-aap-demo-is.md)
- [How the new command and the older one fit together](docs/concepts/two-ways-to-run.md)
- [Notes for the move onto the main download](docs/v2-to-main.md)
- [Design decisions](docs/adr/README.md)
- [Contributing](CONTRIBUTING.md)
