Add git function tutorial #9379

kfurgol · 2020-09-07T10:29:05Z

Description

Changes proposed in this pull request:

Added tutorial on how to create a function using Git repository

Related issue(s)

netlify · 2020-09-07T10:33:46Z

🥰 Documentation preview ready! 🥰

Built with commit 0c0de98

https://deploy-preview-9379--kyma-project-docs-preview.netlify.app

netlify · 2020-09-07T10:38:10Z

🥰 Documentation preview ready! 🥰

Built with commit 4daa717

https://deploy-preview-9379--kyma-project-docs-preview.netlify.app

netlify · 2020-09-07T10:42:22Z

🥰 Documentation preview ready! 🥰

Built with commit 74200d6

https://deploy-preview-9379--kyma-project-docs-preview.netlify.app

magicmatatjahu

Very good! :) I prefer use the function from organisation repo, not from account one of our contributors :)

magicmatatjahu · 2020-09-07T10:36:47Z

docs/serverless/08-02-create-git-function.md

+    metadata:
+      name: $NAME
+    spec:
+      url: "https://github.com/pPrecel/public-gitops"


Please use the https://github.com/kyma-project/examples.git repository. It's better to ref to repo in organisation, not to repo in account one of our contributors.

magicmatatjahu · 2020-09-07T10:37:09Z

docs/serverless/08-02-create-git-function.md

+    apiVersion: serverless.kyma-project.io/v1alpha1
+    kind: GitRepository
+    metadata:
+      name: $NAME


Add also namespace namespace: $NAMESPACE

magicmatatjahu · 2020-09-07T10:37:17Z

docs/serverless/08-02-create-git-function.md

+    apiVersion: serverless.kyma-project.io/v1alpha1
+    kind: Function
+    metadata:
+      name: $NAME


Add also namespace namespace: $NAMESPACE

magicmatatjahu · 2020-09-07T10:38:00Z

docs/serverless/08-02-create-git-function.md

+    EOF
+    ```
+
+>**NOTE** Auth possibility TODO


Please add correct indents (3 or 4 spaces)

magicmatatjahu · 2020-09-07T10:38:27Z

docs/serverless/08-02-create-git-function.md

+      runtime: nodejs12
+      source: $NAME
+      reference: master
+      baseDir: js-handler


Change to orders-service/function

magicmatatjahu · 2020-09-07T10:39:42Z

docs/serverless/08-02-create-git-function.md

+    EOF
+    ```
+
+    >**NOTE** To see full spec, go to the xxx page 


Go to https://github.com/kyma-project/examples/tree/master/orders-service/function

magicmatatjahu · 2020-09-07T10:40:27Z

docs/serverless/08-02-create-git-function.md

+type: Tutorials
+---
+
+This tutorial shows how you can create a simple "Hello World!" Function from Git repository.


This tutorial shows how you can create a Function from Git repository. The function from examples repo is a more complex than Hello World! :)

magicmatatjahu · 2020-09-07T10:41:34Z

docs/serverless/08-02-create-git-function.md

+
+2. Go to the **Functions** view in the left navigation panel and select **Repositories** tab.
+
+3. Click **Connect Repository**,  fill in required fields and click **Connect**.


Click Connect Repository, fill the Url field with https://github.com/kyma-project/examples.git value and click Connect.

magicmatatjahu · 2020-09-07T10:43:11Z

docs/serverless/08-02-create-git-function.md

+
+3. Click **Connect Repository**,  fill in required fields and click **Connect**.
+
+    >**NOTE** Auth possibility TODO


NOTE If you want connect the private repository, change the Authorization field from Public to Key or Basic and fill the required fields -> Auth possibility link TODO

magicmatatjahu · 2020-09-07T10:45:32Z

docs/serverless/08-02-create-git-function.md

+
+4. Go to the **Functions** tab and click **Create Function**.
+
+3. In the pop-up box, change `Source type` to `From Repository`, fill in required fields and select **Create** to confirm changes.


In the pop-up box, change Source type to From Repository, select created Repository's name, fill the Reference field with master and Base directory field with orders-service/function values and select Create to confirm changes.

netlify · 2020-09-07T10:46:34Z

🥰 Documentation preview ready! 🥰

Built with commit 29f675f

https://deploy-preview-9379--kyma-project-docs-preview.netlify.app

kazydek

Added some comments & suggestions.

docs/serverless/08-02-create-git-function.md

kazydek · 2020-09-10T04:59:10Z

docs/serverless/08-02-create-git-function.md

+    Console UI
+    </summary>
+
+1. Create a Namespace or select one from the drop-down list in the top navigation panel.


Sth went wrong with numbering:

A bit better, but it still needs updating:

docs/serverless/08-02-create-git-function.md

kazydek · 2020-09-10T05:04:35Z

docs/serverless/08-02-create-git-function.md

+    ```bash
+    NAME                        CONFIGURED   BUILT   RUNNING   VERSION   AGE
+    test-function               True         True    True      1         18m
+    ```


After changes that @aerfio added, the RUNTIME column is printed as well. See this example.

Pls add the RUNTIME column.

docs/serverless/08-02-create-git-function.md

kazydek · 2020-09-10T05:51:11Z

docs/serverless/08-02-create-git-function.md

+
+4. Go to the **Functions** tab and click **Create Function**.
+
+5. In the pop-up box, change `Source type` to `From Repository`, select created Repository's name, fill the `Reference` field with `master` and `Base directory` field with `orders-service/function` values and select **Create** to confirm changes.


Suggested change

5. In the pop-up box, change `Source type` to `From Repository`, select created Repository's name, fill the `Reference` field with `master` and `Base directory` field with `orders-service/function` values and select **Create** to confirm changes.

5. In the pop-up box, change **Source Type** to `Git repository`, select the repository name, fill in the **Reference** field with `master`, and the **Base Directory** field with `orders-service/function`. Finish by selecting **Create** to confirm changes.

Source type or Source Type?
Base directory or Base Directory?
@magicmatatjahu, help wanted :)

(I asked Maciek and it will be capitalized - as in other views)

docs/serverless/08-02-create-git-function.md

Co-authored-by: Karolina Zydek <karolina.zydek@sap.com>

kazydek · 2020-09-10T11:41:04Z

docs/serverless/08-02-create-git-function.md

+  kubectl
+  </summary>
+
+1. Export these variables:


Sth is wrong with formatting:

kazydek · 2020-09-10T11:42:20Z

docs/serverless/08-02-create-git-function.md

+    Console UI
+    </summary>
+
+1. Create a Namespace or select one from the drop-down list in the top navigation panel.


A bit better, but it still needs updating:

kazydek · 2020-09-10T11:43:31Z

docs/serverless/08-02-create-git-function.md

+    ```bash
+    NAME                        CONFIGURED   BUILT   RUNNING   VERSION   AGE
+    test-function               True         True    True      1         18m
+    ```


Pls add the RUNTIME column.

kazydek · 2020-09-10T11:49:23Z

docs/serverless/08-02-create-git-function.md

+    EOF
+    ```
+
+    >**NOTE** To see other authorization methods, go to the [documentation]().


Ok:
>**NOTE:** Read also about other [supported authentication methods](#details-git-source-type).

kazydek · 2020-09-10T11:51:27Z

docs/serverless/08-02-create-git-function.md

+
+    >**NOTE** If you are using a private repository, add `auth` object with `type` and `secretName` fields to the spec. For details, see [documentation]().
+
+3. Create a Function CR that specifies the Function's logic:


3. Create a Function CR that specifies the Function's logic and points to the directory with code and dependencies in the given repository.

kazydek · 2020-09-10T11:53:08Z

docs/serverless/08-02-create-git-function.md

+      username: <USERNAME>
+      password: <PASSWORD>
+    ```
+   >**NOTE** To see other possible authorization methods, go to the [documentation]().


OK: >**NOTE:** Read also about other [supported authentication methods](#details-git-source-type).

kazydek · 2020-09-10T11:53:57Z

docs/serverless/08-02-create-git-function.md

+
+2. Go to the **Functions** view in the left navigation panel and select the **Repositories** tab.
+
+3. Select **Connect Repository**, fill in the `Url` field with `https://github.com/kyma-project/examples.git`, and confirm by selecting **Connect**.


Suggested change

3. Select **Connect Repository**, fill in the `Url` field with `https://github.com/kyma-project/examples.git`, and confirm by selecting **Connect**.

3. Select **Connect Repository**, fill in the **Url** field with `https://github.com/kyma-project/examples.git`, and confirm by selecting **Connect**.

Sorry, my bad - I didn't notice it before.

kazydek · 2020-09-10T11:55:11Z

docs/serverless/08-02-create-git-function.md

+
+3. Select **Connect Repository**, fill in the `Url` field with `https://github.com/kyma-project/examples.git`, and confirm by selecting **Connect**.
+
+    >**NOTE:** If you want to connect the secured repository with basic authentication, change the **Authorization** field from `Public` to `Basic` and fill the required fields.


Suggested change

>**NOTE:** If you want to connect the secured repository with basic authentication, change the **Authorization** field from `Public` to `Basic` and fill the required fields.

>**NOTE:** If you want to connect the secured repository with basic authentication, change the **Authorization** field from `Public` to `Basic` and fill in the required fields.

Again, my bad.

kazydek · 2020-09-10T12:05:34Z

docs/serverless/08-02-create-git-function.md

+
+4. Go to the **Functions** tab and click **Create Function**.
+
+5. In the pop-up box, change `Source type` to `From Repository`, select created Repository's name, fill the `Reference` field with `master` and `Base directory` field with `orders-service/function` values and select **Create** to confirm changes.


(I asked Maciek and it will be capitalized - as in other views)

docs/serverless/08-02-create-git-function.md

Co-authored-by: Karolina Zydek <karolina.zydek@sap.com>

kfurgol added WIP area/documentation Issues or PRs related to documentation labels Sep 7, 2020

kfurgol requested review from alexandra-simeonova, bszwarc, kazydek, klaudiagrz, majakurcius and mmitoraj as code owners September 7, 2020 10:29

magicmatatjahu suggested changes Sep 7, 2020

View reviewed changes

kfurgol added 8 commits September 9, 2020 12:52

add git function tutorial

5f45b04

fix

3416ef1

fix

685bbc5

fix

539b2f8

fix

b705f9f

review fixes

07f9853

add secret

bf9b005

fix

06ccf4e

kazydek reviewed Sep 10, 2020

View reviewed changes

docs/serverless/08-02-create-git-function.md Outdated Show resolved Hide resolved

kfurgol and others added 2 commits September 10, 2020 12:41

Apply suggestions from code review

59a8a88

Co-authored-by: Karolina Zydek <karolina.zydek@sap.com>

Update docs/serverless/08-02-create-git-function.md

6f219f4

Co-authored-by: Karolina Zydek <karolina.zydek@sap.com>

kazydek reviewed Sep 10, 2020

View reviewed changes

kfurgol added 3 commits September 11, 2020 07:36

Review fix

6ee1015

Review fix

81d5274

Review fix

38dd9c8

kfurgol added 9 commits September 11, 2020 08:43

Review fix

932a305

Review fix

ccc8470

Review fix

3b9deab

Review fix

d644621

Review fix

ed56713

Review fix

6876c46

Review fix

b5cf266

Review fix

3cbf2d1

Review fix

dc7a10d

kazydek reviewed Sep 11, 2020

View reviewed changes

docs/serverless/08-02-create-git-function.md Outdated Show resolved Hide resolved

kfurgol and others added 4 commits September 11, 2020 10:32

Update docs/serverless/08-02-create-git-function.md

ede0c55

Co-authored-by: Karolina Zydek <karolina.zydek@sap.com>

Review fix

36ad12f

Review fix

add9539

Review fix

0b86fed

kazydek previously approved these changes Sep 11, 2020

View reviewed changes

Review fix

29f675f

kfurgol dismissed kazydek’s stale review via 29f675f September 11, 2020 09:25

kfurgol removed the WIP label Sep 11, 2020

magicmatatjahu approved these changes Sep 11, 2020

View reviewed changes

kazydek approved these changes Sep 11, 2020

View reviewed changes

kfurgol merged commit 906b174 into kyma-project:master Sep 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add git function tutorial #9379

Add git function tutorial #9379

kfurgol commented Sep 7, 2020

netlify bot commented Sep 7, 2020

netlify bot commented Sep 7, 2020

netlify bot commented Sep 7, 2020

magicmatatjahu left a comment

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

magicmatatjahu Sep 7, 2020

netlify bot commented Sep 7, 2020 •

edited

Loading

kazydek left a comment

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020 •

edited

Loading

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020

kazydek Sep 10, 2020


		2. Go to the Functions view in the left navigation panel and select Repositories tab.

		3. Click Connect Repository, fill in required fields and click Connect.


		3. Click Connect Repository, fill in required fields and click Connect.

		>NOTE Auth possibility TODO


		4. Go to the Functions tab and click Create Function.

		3. In the pop-up box, change `Source type` to `From Repository`, fill in required fields and select Create to confirm changes.


		4. Go to the Functions tab and click Create Function.

		5. In the pop-up box, change `Source type` to `From Repository`, select created Repository's name, fill the `Reference` field with `master` and `Base directory` field with `orders-service/function` values and select Create to confirm changes.

	5. In the pop-up box, change `Source type` to `From Repository`, select created Repository's name, fill the `Reference` field with `master` and `Base directory` field with `orders-service/function` values and select Create to confirm changes.
	5. In the pop-up box, change Source Type to `Git repository`, select the repository name, fill in the Reference field with `master`, and the Base Directory field with `orders-service/function`. Finish by selecting Create to confirm changes.


		>NOTE If you are using a private repository, add `auth` object with `type` and `secretName` fields to the spec. For details, see [documentation]().

		3. Create a Function CR that specifies the Function's logic:


		2. Go to the Functions view in the left navigation panel and select the Repositories tab.

		3. Select Connect Repository, fill in the `Url` field with `https://github.com/kyma-project/examples.git`, and confirm by selecting Connect.


		3. Select Connect Repository, fill in the `Url` field with `https://github.com/kyma-project/examples.git`, and confirm by selecting Connect.

		>NOTE: If you want to connect the secured repository with basic authentication, change the Authorization field from `Public` to `Basic` and fill the required fields.

Add git function tutorial #9379

Add git function tutorial #9379

Conversation

kfurgol commented Sep 7, 2020

netlify bot commented Sep 7, 2020

netlify bot commented Sep 7, 2020

netlify bot commented Sep 7, 2020

magicmatatjahu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Sep 7, 2020 • edited Loading

kazydek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kazydek Sep 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Sep 7, 2020 •

edited

Loading

kazydek Sep 10, 2020 •

edited

Loading