Skip to content

Commit 14ea612

Browse files
Add docs for the single-command install of the eda-server-operator (#168)
* Add docs for the single-command install of the eda-server-operator Signed-off-by: Christian M. Adams <[email protected]> Co-authored-by: kurokobo <[email protected]>
1 parent c16ae32 commit 14ea612

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ Before you begin, you need to have a k8s cluster up. If you don't already have a
4747

4848
Once you have a running Kubernetes cluster, you can deploy EDA Server Operator into your cluster using [Kustomize](https://kubectl.docs.kubernetes.io/guides/introduction/kustomize/). Since kubectl version 1.14 kustomize functionality is built-in (otherwise, follow the instructions here to install the latest version of Kustomize: https://kubectl.docs.kubernetes.io/installation/kustomize/)
4949

50+
> [!Note]
51+
> If you want to do a single-command install with no modifications, please see these docs [here](./docs/single-command-install.md).
52+
5053
First, create a file called `kustomization.yaml` with the following content:
5154

5255
```yaml

docs/single-command-install.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Single-Command Installation Guide
2+
3+
This document provides comprehensive instructions for the quick, single-command installation of the EDA Server Operator. Also covered are additional details such as prerequisites, uninstallation, and troubleshooting tips.
4+
5+
## Prerequisites
6+
Before proceeding with the installation, ensure that the following prerequisites are met:
7+
8+
1. **Kubernetes Cluster**: You need an active Kubernetes cluster. If you do not have one, you can set it up using platforms like Minikube, Kind, or a cloud provider like AWS, Azure, or GCP.
9+
10+
2. **kubectl**: The Kubernetes command-line tool, kubectl, should be installed and configured to communicate with your cluster. You can check its availability by running `kubectl version`.
11+
12+
## Installation
13+
The EDA Server Operator can be installed using a single command. This command applies a YAML file from the EDA Server Operator's GitHub repository directly to your Kubernetes cluster.
14+
15+
Run the following command in your terminal to install the latest operator
16+
17+
```bash
18+
kubectl apply -f https://github.com/ansible/eda-server-operator/releases/latest/download/operator.yaml
19+
```
20+
21+
If you want to install a specific version instead, modify the version to whichever version you want to install. For example:
22+
23+
```bash
24+
kubectl apply -f https://github.com/ansible/eda-server-operator/releases/download/1.0.0/operator.yaml
25+
```
26+
27+
> [!Note]
28+
> This will create the EDA Server Operator resources in the eda-server-operator-system namespace.
29+
30+
Now create your EDA custom resource by applying the `eda-demo.yml` file and you will soon have a working EDA instance!
31+
32+
```yaml
33+
# eda-demo.yaml
34+
apiVersion: eda.ansible.com/v1alpha1
35+
kind: EDA
36+
metadata:
37+
name: my-eda
38+
spec:
39+
automation_server_url: https://awx-host
40+
```
41+
42+
```bash
43+
kubectl apply -f eda-demo.yaml
44+
```
45+
46+
See the [README.md](../README.md) for more information on configuring EDA by modifying the `spec`.
47+
48+
## Upgrading
49+
50+
## Pre-Upgrade Checklist
51+
52+
* **Backup**: Backup your EDA instance by creating an EDABackup.
53+
* **Review Release Notes**: Check the release notes for the new version of the EDA Server Operator. This can be found on the GitHub [releases page](https://github.com/ansible/eda-server-operator/releases). Pay attention to any breaking changes, new features, or specific instructions for upgrading from your current version.
54+
55+
### Upgrade the Operator
56+
57+
Check the [Releases Page](https://github.com/ansible/eda-server-operator/releases) for the latest EDA Server Operator verion. Copy the URL to the `operator.yaml` artifact for it, then apply it.
58+
59+
For example, if upgrading to version 1.1.0, the command would be:
60+
61+
```bash
62+
kubectl apply -f https://github.com/ansible/eda-server-operator/releases/download/1.1.0/operator.yaml
63+
``````
64+
65+
Monitor the upgrade process by checking the status of the pods in the eda-server-operator-system namespace. You can use the following command:
66+
67+
```bash
68+
kubectl get pods -n eda-server-operator-system
69+
```
70+
71+
72+
## Cleanup
73+
If you wish to remove the EDA Server Operator from your Kubernetes cluster, follow these steps:
74+
75+
Run the following command:
76+
77+
```bash
78+
kubectl delete -f https://github.com/ansible/eda-server-operator/releases/download/1.0.0/operator.yaml
79+
```
80+

0 commit comments

Comments
 (0)