Skip to content

Commit 8d29fa5

Browse files
authored
Update installation documentation to include cluster profiles (#107)
1 parent 8299a1e commit 8d29fa5

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

images/cluster-profile.png

254 KB
Loading

images/plugin-settings.png

-349 KB
Binary file not shown.

images/profile-with-pod-yaml.png

8.02 KB
Loading

images/profile.png

22.1 KB
Loading

images/profile_with_remote_file.png

-93.2 KB
Loading

images/profiles-page.png

37.1 KB
Loading

install.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
* GoCD server version v18.2.0 or above
5+
* GoCD server version v19.3.0 or above
66
* Kubernetes Cluster
77

88
## Installation
@@ -13,10 +13,11 @@ on Windows.
1313

1414
## Configuration
1515

16-
### Configure Plugin Settings
16+
### Configure Cluster Profile
1717

18-
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Plugins_**
19-
2. Click on **_Settings icon_** of `Kubernetes Elastic Agent Plugin` to update plugin settings configuration.
18+
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Profile_**
19+
2. Click on **_Add Cluster Profile_** button and select `Kubernetes Elastic Agent Plugin` from the plugin ID dropdown.
20+
1. Specify `Cluster Profile ID` for the new cluster
2021
1. Optionally specify `Go Server URL`, if GoCD secure site URL is not configured.
2122
2. Optionally Specify `Agent auto-register Timeout`, Defaults to `10 mintues`.
2223
3. Optionally Specify `Maximum pending pods`, Defaults to `10 pods`.
@@ -31,17 +32,18 @@ on Windows.
3132
```
3233
7. Optionally, Specify `Cluster ca certificate data`.
3334
34-
!["Kubernetes Plugin settings"][1]
35+
!["Kubernetes Cluster Profile"][1]
3536
36-
## Create an elastic profile
37+
## Create an Elastic Agent Profile
3738
38-
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Agent Profiles_**
39+
1. Login to `GoCD server` as admin and navigate to **_Admin_** _>_ **_Elastic Profile_**
3940
![Elastic Profiles][2]
4041
41-
2. Click on **_Add_** to create new elastic agent profile
42+
2. Click on **_New Elastic Agent Profile_** to create new elastic agent profile for a cluster.
4243
1. Specify `id` for profile.
4344
2. Select `Kubernetes Elastic Agent Plugin` for **_Plugin id_**
44-
3. Configure Kubernetes GoCD elastic agent Pod using:
45+
3. Verify Cluster Profile Id of the newly defined Elastic Agent Profile.
46+
4. Configure Kubernetes GoCD elastic agent Pod using:
4547
- Config Properties
4648
1. Specify GoCD elastic agent docker image name.
4749
2. Specify Maximum Memory limit. Container memory will be limit to the value specified here.
@@ -60,7 +62,7 @@ on Windows.
6062
6163
![Create elastic profile using remote file configuration][8]
6264
63-
4. Save your profile.
65+
5. Save your profile.
6466
6567
6668
@@ -97,11 +99,11 @@ $ GO_SERVER_SYSTEM_PROPERTIES="-Dplugin.cd.go.contrib.elasticagent.kubernetes.lo
9799
```
98100

99101

100-
[1]: images/plugin-settings.png "Kubernetes Plugin settings"
102+
[1]: images/cluster-profile.png "Kubernetes Cluster Profile"
101103
[2]: images/profiles-page.png "Elastic profiles"
102104
[3]: images/profile.png "Create elastic profile using config properties"
103105
[4]: images/profile-with-pod-yaml.png "Create elastic profile using pod configuration"
104106
[5]: images/pipeline.png "Pipeline"
105107
[6]: images/quick-edit.png "Quick edit"
106108
[7]: images/configure-job.png "Configure a job"
107-
[8]: images/profile_with_remote_file.png "Create elastic profile using remote file configuration"
109+
[8]: images/profile_with_remote_file.png "Create elastic profile using remote file configuration"

0 commit comments

Comments
 (0)