Skip to content

Commit db7f34a

Browse files
authored
Merge pull request kabanero-io#336 from kabanero-io/335-jantley-reviewedits
review edits and more terminology
2 parents bda9bc7 + 6ba5053 commit db7f34a

5 files changed

Lines changed: 15 additions & 15 deletions

File tree

ref/general/configuration/kabanero-cr-config.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ installation. This description includes the locations of the application
1010
stacks, and how the Kabanero CLI should interact with GitHub.
1111

1212
The `Spec` section of the `Kabanero` instance describes the desired
13-
configuration. The `Status` section is populated by the Kabanero operator,
13+
configuration. The `Status` section is populated by the product operator,
1414
and shows the versions of the components that make up Kabanero. In some
1515
cases, the `Status` also contains URLs that can be used to interact with
1616
the components of Kabanero.
@@ -87,7 +87,7 @@ specify the following fields:
8787
three hours, thirty minutes and thirty seconds.
8888
** `landing`
8989
*** `enable` - Controls whether the Kabanero landing page is deployed by
90-
the Kabanero operator. Valid values are `true` and `false`. The default
90+
the product operator. Valid values are `true` and `false`. The default
9191
value is `true`.
9292
** `codeReadyWorkspaces`
9393
*** `enable` - Controls whether Kabanero will deploy an instance of
@@ -120,7 +120,7 @@ specify the following fields:
120120
define the realm that the SSO server will use. For more information
121121
about setting up the secret, see link:rhsso.html[the SSO configuration instructions].
122122

123-
The following `Status` fields are maintained by the Kabanero operator to
123+
The following `Status` fields are maintained by the product operator to
124124
provide information about the installed components, and the health of the
125125
Kabanero instance:
126126

@@ -182,7 +182,7 @@ Kabanero instance:
182182
*** `message` - Provides more details for a `ready` status of `False`.
183183
*** `version` - The version of the landing page that was deployed.
184184
** `appsody` - Contains information about the application operator that was
185-
deployed by the Kabanero operator.
185+
deployed by the product operator.
186186
*** `ready` - The overall status of the application operator. A value
187187
of `True` indicates the operator was deployed successfully. A value of
188188
`False` indicates there was a problem, and more information can be found
@@ -203,7 +203,7 @@ Kabanero instance:
203203
kAppNav. This information is copied from the `Route` for the kAppNav API
204204
service.
205205
** `codereadyWorkspaces` - Contains information about the CodeReady
206-
Workspaces instance that is deployed by the Kabanero operator.
206+
Workspaces instance that is deployed by the product operator.
207207
*** `ready` - The overall status of CodeReady Workspaces. A value of `True`
208208
indicates it was installed and configured successfully. A value of
209209
`False` indicates that there was a problem, and more information can be

ref/general/configuration/rhsso.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:sectanchors:
66
= Configuring Kabanero with Red Hat Single Sign On
77

8-
After Kabanero is installed, the Kabanero operator can optionally create an instance of Red Hat Single Sign On (RHSSO) for development use.
8+
After Kabanero is installed, the product operator can optionally create an instance of Red Hat Single Sign On (RHSSO) for development use.
99
To create the RHSSO instance, create the required secret and the persistent volume and then edit the Kabanero custom resource (CR).
1010

1111
. Create a persistent volume (PV) of size 1 GB. The type of storage used might vary depending on the environment where OpenShift is installed.

ref/general/configuration/stack-cr-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ specify the following fields:
2727
that this version of this stack should remain in. An empty
2828
value results in this version being activated. Other valid
2929
values are `active` and `inactive`. If either of these values
30-
is provided, the Kabanero operator will not attempt to change
30+
is provided, the product operator will not attempt to change
3131
the state for this version, even if the stack is removed from
3232
the stack index which caused this Stack CR to be created.
3333
This behavior can be used to permanently activate or deactivate

ref/general/configuration/stack-install.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For more information about other fields that can be customized in the Kabanero C
5656
+
5757
After editing, save your changes. The updated Kabanero CR instance is applied to your cluster.
5858

59-
. The Kabanero operator will now load the stacks in the repository. To see a list of all stacks in the `kabanero` namespace, use `oc get stacks -n kabanero`. If the kabanero-operator is unable to apply the stacks, the `Status` section of the Kabanero CR instance or the Stack CR instances will contain more information.
59+
. The product operator will now load the stacks in the repository. To see a list of all stacks in the `kabanero` namespace, use `oc get stacks -n kabanero`. If the kabanero-operator is unable to apply the stacks, the `Status` section of the Kabanero CR instance or the Stack CR instances will contain more information.
6060

6161
== Need help?
6262
If you have questions, we would like to hear from you.

ref/general/configuration/tekton-webhooks.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
:page-layout: doc
22
:page-doc-category: Configuration
3-
:page-title: Connecting Kabanero to GitHub with webhooks
3+
:page-title: Connecting to GitHub with webhooks
44
:sectanchors:
55
:page-doc-number: 5.0
6-
= Connecting Kabanero to GitHub with webhooks
6+
= Connecting to GitHub with webhooks
77

88
A webhook is an outbound HTTP request that helps you create a relationship between your GitHub repository and a particular URL, in this case a https://github.com/kabanero-io/kabanero-pipelines/blob/master/README.md[pipeline, window="_blank"]. After you configure the webhook, changes you make in your GitHub repository will trigger the pipeline and its associated tasks.
99
1010
== Prerequisites
1111
1212
* A GitHub repository
13-
* https://github.com/kabanero-io/kabanero-foundation/tree/master/scripts[Kabanero Foundation, window="_blank"].
14-
** Your Kabanero installation must include an instance of the https://github.com/tektoncd/dashboard#installing-the-latest-release[pipelines dashboard, window="_blank"] with the https://github.com/tektoncd/experimental/blob/master/webhooks-extension/README.md[webhooks extension, window="_blank"] and https://github.com/tektoncd/triggers/tree/v0.1.0/docs#tekton-triggers[triggers, window="_blank"] installed.
13+
* https://kabanero.io/docs/ref/general/installation/installing-kabanero-foundation.md[Kabanero Foundation, window="_blank"].
14+
** The product operator installation will include an instance of the pipelines dashboard with the webhooks extension and triggers.
1515
1616
== Create a persistent volume
1717
Pipelines need a persistent volume. For more information, see *Setting up a persistent volume to run pipelines* in the https://kabanero.io/guides/working-with-pipelines/[Build and deploy applications with pipelines, window="_blank"] guide.
@@ -54,14 +54,14 @@ Namespace::
5454
Select the Kubernetes namespace in which you want to run your pipeline. In this case, choose `kabanero`.
5555
5656
Pipeline::
57-
Select the pipeline in your target Namespace. PipelineRuns (and their accompanying PipelineResources) are created in this namespace. For more information, see https://github.com/kabanero-io/kabanero-pipelines#kabanero-pipelines[Kabanero Pipelines, window="_blank"].
57+
Select the pipeline in your target Namespace. PipelineRuns (and their accompanying PipelineResources) are created in this namespace. For more information, see https://github.com/kabanero-io/kabanero-pipelines#kabanero-pipelines[Pipelines, window="_blank"].
5858
5959
Service Account::
6060
Select a service account to be used by the PipelineRun. There are two default service account options. Either of these accounts can be used as a template to create your own customized service accounts that fit your pipeline requirements.
6161
6262
* If you are deploying pipelines in a single namespace, the `pipeline` service account is provided, which has permissions to build and push an image. This service account can be used with simple pipelines. However, it has limited access to the current namespace and does not work for cross-namespace operations and deployments.
6363
64-
* If you need to deploy pipelines across multiple namespaces, the product operator provides the `kabanero-pipeline` service account with this capability. If you are running a custom pipeline that requires more or less access than the kabanero-pipeline service account is configured to provide, do not edit this account. Instead, create a new service account, such as `custom-kabanero-pipeline-sa`, and configure it according to your needs. For example service accounts, see the link:https://github.com/kabanero-io/kabanero-pipelines/tree/master/pipelines/common[Kabanero pipelines repo].
64+
* If you need to deploy pipelines across multiple namespaces, the product operator provides the `kabanero-pipeline` service account with this capability. If you are running a custom pipeline that requires more or less access than the kabanero-pipeline service account is configured to provide, do not edit this account. Instead, create a new service account, such as `custom-kabanero-pipeline-sa`, and configure it according to your needs using one of the provided service accounts as an example.
6565
6666
Docker registry::
6767
Select the Docker registry where any built images are pushed. Use the same Docker registry that you created a secret for previously. For Docker Hub, use `index.docker.io/<docker_id>`. For an internal registry, use `docker-registry.default.svc:5000/kabanero`. If the namespace that is associated with your internal registry is not `kabanero`, use `docker-registry.default.svc:5000/your-namespace`.
@@ -79,7 +79,7 @@ Select the Docker registry where any built images are pushed. Use the same Docke
7979
. Check the PipelineRun from your pipelines dashboard.
8080
* From your pipelines dashboard, select `PipelineRuns` from the sidebar menu. Look for the PipelineRun you just kicked off.
8181
82-
Your GitHub repo is connected to Kabanero with a webhook. Changes in your code can now automatically trigger tasks that are specified by the pipeline.
82+
Your GitHub repo is connected using a webhook. Changes in your code can now automatically trigger tasks that are specified by the pipeline. If you don't see a PipelineRun in your dashboard, see the https://kabanero.io/docs/ref/general/reference/troubleshooting.html#errors-when-using-a-webhook-to-trigger-pipelines[troubleshooting guide].
8383
8484
== Deleting a webhook
8585

0 commit comments

Comments
 (0)