Skip to content

Commit

Permalink
Update creating.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Chr1st1anSears authored May 16, 2024
1 parent ce42c95 commit bab57fe
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/modules/ROOT/pages/how-tos/creating.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Creating applications and components

To create an application in {ProductName}, someone must enable build pipelines in your instance of {ProductName}. This includes creating a GitHub application, so {ProductName} can access users' pull requests, and configuring a smee channel, to listen for those PRs. The first procedure in this document explains how to perform these tasks.
To create an application in {ProductName}, someone must enable build pipelines in your instance of {ProductName}. This includes creating a GitHub App, so {ProductName} can access users' pull requests, and configuring a smee channel, to listen for those PRs. The first procedure in this document explains how to perform these tasks.

Once build pipelines are enabled, users can create their applications in {ProductName}. The second procedure below describes how to create an application.

Expand All @@ -13,7 +13,7 @@ Once build pipelines are enabled, users can create their applications in {Produc

.Procedure:

. Create a GitHub app according to link:https://pipelinesascode.com/docs/install/github_apps/#manual-setup[these Pipelines as Code instructions].
. Create a GitHub App according to link:https://pipelinesascode.com/docs/install/github_apps/#manual-setup[these Pipelines as Code instructions].
. Start a new link:https://smee.io/[smee] channel.
. In the repository for your instance of {ProductName}, edit the file /smee/smee-client.yaml. Replace <smee-channel> with the webhook proxy URL from the previous step.

Expand All @@ -22,23 +22,23 @@ Once build pipelines are enabled, users can create their applications in {Produc
.Prerequisites:

* link:https://kubernetes.io/docs/tasks/tools/[kubectl] CLI tool
* The following values from your {ProductName} GitHub application:
* The following values from your {ProductName} GitHub App:
** The private key
** The application ID
** The App ID
** The webhook secret
* A GitHub repository with source code for your application
** It must have the same basic structure as our example repository
* Read/write access to the repository for your instance of {ProductName}

.Procedure:

. In the GitHub repository for your application, install your organization’s {ProductName} GitHub application.
. In the GitHub repository for your application, install your organization’s {ProductName} GitHub App.
. In the repository for your instance of {ProductName}, you need to replace two `url` values in the relevant YAML file for your namespace. The path for this file is `/test/resources/demo-users/user/<namespace>/application-and-component.yaml`. Replace the two `url` values as follows:
.. For the `url` value beneath `git`, provide the URL that you would use to locally clone your application’s repository. This URL ends with `.git`.
.. For the `url` value beneath `spec`, at the end of the file, provide the URL for your application’s repository that you see in your browser, without `.git` at the end.
+
NOTE: To add other components to the same namespace, reference the example YAML file beneath this procedure.
. Login to {ProductName} xref:../getting-started/cli.adoc[through your CLI].
. Login to the Kubernetes cluster where Konflux is deployed.
. Run the following command. Be sure to replace <namespace> with your actual namespace.
+
`kubectl create -f /test/resources/demo-users/user/<namespace>/application-and-component.yaml`
Expand Down

0 comments on commit bab57fe

Please sign in to comment.