Adjust Application Connectivity docs to Kyma 2.0, pt.2 #12465

majakurcius · 2021-10-26T13:51:57Z

Description

Update the Application Connectivity 2.0 docs to Kyma 2.0

Changes proposed in this pull request:

Adjust the tutorials to the new Application Connectivity solution (central App Gateway and App Conn Validator)
Adjust the tutorials forming the main flow to use environment variables instead of re-typing the names for APP_NAME, CLUSTER_DOMAIN, CLIENT_CERTIFICATE_FILE_NAME, KEY_FILE_NAME, SERVICE_ID.

Related issue(s)
#11047

netlify · 2021-10-26T13:57:45Z

✔️ 🥰 Documentation preview ready! 🥰

🔨 Explore the source changes: 0e4601f

🔍 Inspect the deploy log: https://app.netlify.com/sites/kyma-project-docs-preview/deploys/61968f994305210007447212

😎 Browse the preview: https://deploy-preview-12465--kyma-project-docs-preview.netlify.app

…o AC modes to AC overview intro

…from the Application CR doc

docs/05-technical-reference/00-custom-resources/ac-01-application.md

docs/01-overview/main-areas/application-connectivity/README.md

docs/01-overview/main-areas/application-connectivity/ac-05-useful-links.md

klaudiagrz · 2021-11-16T12:45:20Z

docs/03-tutorials/00-application-connectivity/ac-02-get-client-certificate.md

@@ -83,18 +84,28 @@ A successful call returns the following response:
 }
 ```

-> **NOTE:** The response contains URLs to the Application Registry API and the Events Publisher API, however, it is not recommended to use them. You should call the `metadata` endpoint URL, which is provided in `api.infoUrl` property, to fetch correct URLs to the Application Registry API and to the Events Publisher API, and other configuration details.
+> **NOTE:** The response contains URLs to the Application Registry API and the Events Publisher API, however, using them is not recommended. You should call the `metadata` endpoint URL, which is provided in the **api.infoUrl** property, to fetch correct URLs to the Application Registry API and to the Events Publisher API, and other configuration details.


The second sentence feels a bit too long. Can we chunk it into two shorter ones?

docs/03-tutorials/00-application-connectivity/ac-05-call-registered-service-from-kyma.md

docs/04-operation-guides/operations/ra-01-enable-kyma-with-runtime-agent.md

docs/03-tutorials/00-application-connectivity/ac-05-call-registered-service-from-kyma.md

klaudiagrz

LGTM 🚀

docs/03-tutorials/00-application-connectivity/ac-09-get-api-specification.md

…pitalization for systems

…d remove '-k' from curl commands

…bsite

klaudiagrz

LGTM

… export as env var, fix typo in KEY file name

majakurcius · 2021-11-18T17:42:37Z

docs/03-tutorials/00-application-connectivity/ac-02-get-client-certificate.md

-## Call Application Registry and Event Publisher on local deployment
-
-Since the local Kyma installation uses the self-signed certificate by default, skip TLS verification.
-
-Call Application Registry with this command:
-
-```bash
-curl https://gateway.local.kyma.dev/{APP_NAME}/v1/metadata/services --cert {CLIENT_CERT_FILE_NAME}.crt --key {KEY_FILE_NAME}.key -k
-```


I removed this part, 'cause we don't want to have commands for local deployment specifically, just mention to skip cert verification (we have such a note at the top of the document), and if we turn it into a general command working for both a local and remote cluster, it becomes the same as the command in the previous section.

majakurcius · 2021-11-18T17:43:36Z

docs/03-tutorials/00-application-connectivity/ac-02-get-client-certificate.md

-   openssl req -new -sha256 -out generated.csr -key generated.key -subj "/OU=OrgUnit/O=Organization/L=Waldorf/ST=Waldorf/C=DE/CN={APP_NAME}"
-   openssl base64 -in generated.csr
+   openssl req -new -sha256 -out $CSR_FILE_NAME.csr -key $KEY_FILE_NAME.key -subj "/OU=OrgUnit/O=Organization/L=Waldorf/ST=Waldorf/C=DE/CN=$APP_NAME"
+   openssl base64 -in $CSR_FILE_NAME.csr -A


I added -A here because it gets rid of the newlines in the printed CSR, which I otherwise have to remove manually.

majakurcius · 2021-11-18T17:45:38Z

docs/03-tutorials/00-application-connectivity/ac-05-call-registered-service-from-kyma.md

+2. Export the ID of the registered service and the Namespace in which to create the Function that calls the service as environment variables:

   ```bash
   export SERVICE_ID={YOUR_SERVICE_ID}
   export NAMESPACE={YOUR_NAMESPACE}


I added exporting the Namespace to an env var back here since I mistakenly removed it before.

Modify the tutorials to export APP_NAME as an env variable

685a03b

majakurcius added area/documentation Issues or PRs related to documentation area/application-connector Issues or PRs related to application connectivity do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Oct 26, 2021

majakurcius self-assigned this Oct 26, 2021

majakurcius requested review from alexandra-simeonova, klaudiagrz, mmitoraj and NHingerl as code owners October 26, 2021 13:51

kyma-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Oct 26, 2021

majakurcius added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Oct 26, 2021

majakurcius changed the title ~~Adjust Application Connectivity docs to Kyma 2.0, pt.2~~ Adjust Application Connectivity docs to Kyma 2.0, pt.2 [WIP] Oct 26, 2021

majakurcius added 14 commits October 29, 2021 13:21

Adjust the local cluster domain and add minor editorial fixes

82641fe

Adjust the tutorial to the new Application Connectivity 2.0 solution

35ea5cc

Adjust the tutorials to the new local domain and add minor fixes

eed0d14

Update tutorial on custom CA cert and key

b81fa95

Add description for links to App Conn troubleshooting guides

18e7d42

Remove the obsolete tutorial on accessing AC on a local Kyma deployment

db95fdb

Update the tutorial on how to enable Runtime Agent and add info on tw…

c51159e

…o AC modes to AC overview intro

Add disclaimers on legacy and Compass mode

ced85cb

Simplify language and remove deprecated Service Catalog-related info …

f5bc3bd

…from the Application CR doc

Remove outdate note on Compass from RA overview

ccd9761

Minor lg fix

20cac5f

Remove the definite article preceding Connector Service

98d3fe9

Add minor lg fixes

9a61ed8

Remove obsolete spaces

063127c

majakurcius commented Nov 3, 2021

View reviewed changes

docs/05-technical-reference/00-custom-resources/ac-01-application.md Show resolved Hide resolved

klaudiagrz self-assigned this Nov 16, 2021

klaudiagrz reviewed Nov 16, 2021

View reviewed changes

majakurcius commented Nov 17, 2021

View reviewed changes

docs/03-tutorials/00-application-connectivity/ac-05-call-registered-service-from-kyma.md Outdated Show resolved Hide resolved

Apply review suggestions

590b8b9

majakurcius added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 17, 2021

Capitalize 'Other'

16a1c4c

klaudiagrz reviewed Nov 18, 2021

View reviewed changes

klaudiagrz previously approved these changes Nov 18, 2021

View reviewed changes

kyma-bot added the lgtm Looks good to me! label Nov 18, 2021

majakurcius commented Nov 18, 2021

View reviewed changes

docs/03-tutorials/00-application-connectivity/ac-09-get-api-specification.md Outdated Show resolved Hide resolved

Bring back specifying a Namespace for Function and APIRule and fix ca…

145b256

…pitalization for systems

majakurcius dismissed klaudiagrz’s stale review via 145b256 November 18, 2021 11:05

kyma-bot removed the lgtm Looks good to me! label Nov 18, 2021

majakurcius added 2 commits November 18, 2021 15:13

Add a CAUTION note about skipping certificate verification locally an…

9975545

…d remove '-k' from curl commands

Remove an outdate instruction about getting the API specs from the we…

f25adbf

…bsite

klaudiagrz previously approved these changes Nov 18, 2021

View reviewed changes

kyma-bot added the lgtm Looks good to me! label Nov 18, 2021

Add '-A' to remove newlines, remove commands for local, add Namespace…

0e4601f

… export as env var, fix typo in KEY file name

majakurcius dismissed klaudiagrz’s stale review via 0e4601f November 18, 2021 17:38

kyma-bot removed the lgtm Looks good to me! label Nov 18, 2021

majakurcius commented Nov 18, 2021

View reviewed changes

majakurcius changed the title ~~Adjust Application Connectivity docs to Kyma 2.0, pt.2 [WIP]~~ Adjust Application Connectivity docs to Kyma 2.0, pt.2 Nov 18, 2021

klaudiagrz approved these changes Nov 19, 2021

View reviewed changes

kyma-bot added the lgtm Looks good to me! label Nov 19, 2021

akgalwas approved these changes Nov 19, 2021

View reviewed changes

majakurcius removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 19, 2021

kyma-bot merged commit 0c37f5e into kyma-project:main Nov 19, 2021

majakurcius mentioned this pull request Mar 2, 2022

Remove Application Operator and Access Service creation in Application Registry #12845

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust Application Connectivity docs to Kyma 2.0, pt.2 #12465

Adjust Application Connectivity docs to Kyma 2.0, pt.2 #12465

majakurcius commented Oct 26, 2021 •

edited

netlify bot commented Oct 26, 2021 •

edited

klaudiagrz Nov 16, 2021

klaudiagrz left a comment

klaudiagrz left a comment

majakurcius Nov 18, 2021

majakurcius Nov 18, 2021

majakurcius Nov 18, 2021 •

edited

Adjust Application Connectivity docs to Kyma 2.0, pt.2 #12465

Adjust Application Connectivity docs to Kyma 2.0, pt.2 #12465

Conversation

majakurcius commented Oct 26, 2021 • edited

netlify bot commented Oct 26, 2021 • edited

klaudiagrz Nov 16, 2021

Choose a reason for hiding this comment

klaudiagrz left a comment

Choose a reason for hiding this comment

klaudiagrz left a comment

Choose a reason for hiding this comment

majakurcius Nov 18, 2021

Choose a reason for hiding this comment

majakurcius Nov 18, 2021

Choose a reason for hiding this comment

majakurcius Nov 18, 2021 • edited

Choose a reason for hiding this comment

majakurcius commented Oct 26, 2021 •

edited

netlify bot commented Oct 26, 2021 •

edited

majakurcius Nov 18, 2021 •

edited