Skip to content

Commit c1a7637

Browse files
authored
Update README.md
Updated README.md file with more detail.
1 parent 036ac0b commit c1a7637

1 file changed

Lines changed: 28 additions & 8 deletions

File tree

ast-on-k8s/README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Running the Application Study Tool in Kubernetes
22

3-
This directory contains the manifest files for running the Application Study Tool in a Kubernetes cluster
3+
This directory contains the manifest files for running the Application Study Tool in a Kubernetes cluster.
4+
I used Kompose (https://kompose.io/) to create the initial YAML files, but needed to make changes for this to actually work in a production-grade Kubernetes cluster:
5+
- Added permissions
6+
- Created the needed configmaps and secrets
47

58
To just clone this directory (./ast-on-k8s), where the Kubernetes manifest files are located, you can follow these steps:
69
```
7-
$ mkdir ast-on-k8s
8-
$ cd ast-on-k8s
9-
$ git init
10-
$ git remote add -f origin https://github.com/javajason/ast-config-wizard
11-
$ git config core.sparseCheckout true
12-
$ echo “ast-on-k8s/“ >> .git/info/sparse-checkout
13-
$ git pull origin main
10+
mkdir ast-on-k8s
11+
cd ast-on-k8s
12+
git init
13+
git remote add -f origin https://github.com/javajason/ast-config-wizard
14+
git config core.sparseCheckout true
15+
echo “ast-on-k8s/“ >> .git/info/sparse-checkout
16+
git pull origin main
1417
```
1518

1619
You will also need to modify the following files, at minimum.
@@ -25,6 +28,23 @@ You will also need to modify the following files, at minimum.
2528

2629
Other files in this directory can also be modified for additional customization. See the original repo (https://github.com/f5devcentral/application-study-tool) for specific customization guidance.
2730

31+
Deploy the AST application on Kubernetes using the following command. This requires the _kubectl_ client to be installed ahead of time and configured to connect and authenticate with your Kubernetes cluster.
32+
```
33+
kubectl create -f .
34+
```
35+
36+
To verify AST has been successfully deployed, run the following command:
37+
```
38+
kubectl get pods
39+
```
40+
You should see output similar to the following:
41+
```
42+
$ kubectl get pods
43+
NAME READY STATUS RESTARTS AGE
44+
grafana-54c8bbb46b-kf8fv 1/1 Running 0 2m14s
45+
otel-collector-5b87d546b6-rnkml 1/1 Running 0 2m13s
46+
prometheus-69cbc96779-vcrhz 1/1 Running 0 2m13s
47+
```
2848

2949
So far, it has been tested on the following platforms:
3050
- Azure Kubernetes Services (AKS)

0 commit comments

Comments
 (0)