Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the AC module documentation #69

Merged
merged 2 commits into from
Oct 17, 2023
Merged

Improve the AC module documentation #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48b66ae
Improve the AC module documentation
grego952 Oct 13, 2023
b30b119
apply suggestions from koala7659 review
grego952 Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,11 @@ metadata:
app.kuberentes.io/managed-by: kustomize
app.kubernetes.io/created-by: application-connector-manager
name: applicationconnector-sample
spec:
disableLegacyConnectivity : "false"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example of fully configured CR:

domainName: c-9057319.dev.kyma.ondemand.com
appConnValidator:
  logLevel: "info"
  logFormat: "json"
appGateway:
  proxyTimeout: "10s"
  requestTimeout: "10s"
  logLevel: "info"

All parametes are optional. The simplest spec is

spec: {}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, I added the simplest spec spec: {}

spec: {}
```

Any update to this CR is intercepted by Application Connector Manager and applied to the Application Connector binaries.

> **NOTE:** At this stage of development, the ApplicationConnector Custom Resource Definition (CRD) contains only one parameter for testing.
> The ApplicationConnector CRD will be extended during further development.

See also:
- [Lifecycle Manager documentation](https://github.com/kyma-project/lifecycle-manager#lifecycle-manager)
- [Application Connector module documentation](docs/user/README.md)
Expand Down
7 changes: 0 additions & 7 deletions docs/user/02-20-enable-kyma-with-runtime-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,5 @@

[Runtime Agent](00-30-runtime-agent-overview.md) is a part of the Application Connector module that is used in the [Compass mode](README.md) of Application Connectivity.
By default, Kyma uses the [standalone Application Connectivity mode](README.md), which does not support integration with Compass.
Because of this, on installation, you must:
- Disable the components used in the standalone mode by setting the **global.disableLegacyConnectivity** value to `true`, and
- Add the `compass-runtime-agent` module in the `kyma-system` Namespace to the [list of components](https://github.com/kyma-project/kyma/blob/main/installation/resources/components.yaml)

```yaml
kyma deploy --value global.disableLegacyConnectivity="true" --components-file {YOUR_COMPONENTS_FILE_PATH}
```

>**TIP:** Read more about how to [change Kyma settings](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/03-change-kyma-config-values.md) and [install Kyma with specific components](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/02-install-kyma.md#install-specific-components).
13 changes: 0 additions & 13 deletions docs/user/technical-reference/05-10-application-connector-chart.md
View file
Open in desktop

This file was deleted.

Loading