# autosetup

> Tool to install autoapply in a Kubernetes cluster

Latest version **0.10.1** (published 2023-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install autosetup
pnpm add autosetup
yarn add autosetup
bun add autosetup
```

Provides the command `autosetup`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.1 |
| Published | 2023-12-13 |
| First published | 2018-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Pascal |
| Maintainers | pascalgn |

## Links

- npm: https://www.npmjs.com/package/autosetup
- Repository: https://github.com/autoapply/autosetup
- npm.io page: https://npm.io/package/autosetup

## Dependencies (7)

- [ajv](https://npm.io/package/ajv.md) ^8.12.0
- [ejs](https://npm.io/package/ejs.md) ^3.1.9
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [pkginfo](https://npm.io/package/pkginfo.md) ^0.4.1
- [argparse](https://npm.io/package/argparse.md) ^2.0.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [tmp-promise](https://npm.io/package/tmp-promise.md) ^3.0.3

## Recent versions

- 0.10.1 (latest) — 2023-12-13
- 0.10.0 — 2023-12-13
- 0.9.6 — 2023-12-13
- 0.9.5 — 2023-07-10
- 0.9.4 — 2023-07-10
- 0.9.3 — 2023-07-10
- 0.9.2 — 2023-07-10
- 0.9.1 — 2022-04-07
- 0.9.0 — 2022-04-06
- 0.8.5 — 2022-04-06
- 0.8.4 — 2021-06-25
- 0.8.3 — 2020-09-18
- 0.8.2 — 2020-04-29
- 0.8.1 — 2020-03-15
- 0.8.0 — 2020-01-15
- … 23 more at https://npm.io/package/autosetup/versions

## README

# autosetup

[![CircleCI](https://img.shields.io/circleci/build/github/autoapply/autosetup/main?style=flat-square)](https://app.circleci.com/pipelines/github/autoapply/autosetup) [![Docker Pulls](https://img.shields.io/docker/pulls/autoapply/autosetup?style=flat-square)](https://hub.docker.com/r/autoapply/autosetup/) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/autoapply/autosetup/blob/main/LICENSE)

Quickly set up [autoapply](https://github.com/autoapply/autoapply) in a Kubernetes cluster.

![Technical overview](https://autoapply.github.io/autosetup/overview.svg)

1. Create a configuration file with the repository URL and required secrets
2. Run autosetup to create Kubernetes resource files based on the configuration file
3. Apply the resource files to your Kubernetes cluster to create the autoapply deployment

## Usage

Run autosetup by using the Docker image `autoapply/autosetup`.

```bash
$ docker run --rm autoapply/autosetup \
    -c git.url=https://github.com/autoapply/template-kubectl \
    -c 'kubernetes.paths=["common","dev"]' \
    -c kubernetes.namespace=autoapply-test \
    > output.yaml
info: All templates successfully generated!
$ cat output.yaml
$ kubectl apply -f output.yaml
```

Alternatively, you can also install it locally using `yarn global add autosetup` or `npm install -g autosetup`.

<p align="center">
  <img  width="800" src="https://autoapply.github.io/autosetup/demo.svg">
</p>

## Configuration

A simple configuration file looks like this:

```yaml
git:
  url: "https://github.com/autoapply/template-kubectl"
kubernetes:
  paths:
    - "common"
    - "dev"
```

For more details, see [example-config.yaml](example-config.yaml).

See [template-kubectl](https://github.com/autoapply/template-kubectl) and [template-kustomize](https://github.com/autoapply/template-kustomize) for example repositories.

### SSH key

The SSH key to access Git repositories can be generated using

```bash
$ ssh-keygen -N '' -m PEM -b 4096 -t rsa -f id_rsa -C autoapply
```

### yaml-crypt keys

A new [yaml-crypt](https://github.com/autoapply/yaml-crypt) key can be generated using

```bash
$ yaml-crypt --generate-key
```

### sops configuration

For information on how to setup sops, see the [documentation](https://github.com/mozilla/sops).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/autosetup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._