Skip to content

Commit baf5e5e

Browse files
committed
Add missing plugin parameters to documentation
1 parent 4cc1fa1 commit baf5e5e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/Home.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,12 @@ The GKE Build Step has the following parameters:
184184
185185
1. `credentialsId(string)`: The ID of the credentials that you uploaded earlier.
186186
1. `projectId(string)`: The Project ID housing the GKE cluster to be published to.
187-
1. `zone(string)`: [**Deprecated**] The Zone housing the GKE cluster to be published to.
188187
1. `location(string)`: The Zone or Region housing the GKE cluster to be published to.
189188
1. `clusterName(string)`: The name of the Cluster to be published to.
189+
1. `namespace(string)`: The namespace Kubernetes objects are deployed to.
190190
1. `manifestPattern(string)`: The file pattern of the Kubernetes manifest to be deployed.
191-
1. `verifyDeployments(boolean)`: [Optional] Whether the plugin will verify deployments.
191+
1. `verifyDeployments(boolean)`: [Optional] Whether the plugin will verify deployments. Default is `true`.
192+
1. `verifyTimeoutInMinutes(integer)`: [Optional] Time in minutes to wait for deployments to verify. Default is 5 minutes.
192193
193194
#### Jenkins Web UI
194195
@@ -215,6 +216,7 @@ pipeline {
215216
PROJECT_ID = '<YOUR_PROJECT_ID>'
216217
CLUSTER_NAME = '<YOUR_CLUSTER_NAME>'
217218
LOCATION = '<YOUR_CLUSTER_LOCATION>'
219+
NAMESPACE = '<YOUR_KUBERNETES_NAMESPACE>'
218220
CREDENTIALS_ID = '<YOUR_CREDENTIAS_ID>'
219221
}
220222
stages {
@@ -226,8 +228,10 @@ pipeline {
226228
clusterName: env.CLUSTER_NAME,
227229
location: env.LOCATION,
228230
manifestPattern: 'manifest.yaml',
231+
namespace: env.NAMESPACE,
229232
credentialsId: env.CREDENTIALS_ID,
230-
verifyDeployments: true])
233+
verifyDeployments: true,
234+
verifyTimeoutInMinutes: 5])
231235
}
232236
}
233237
}

0 commit comments

Comments
 (0)