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.

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

AddonConfiguration well documented in kyma-project.io #4758

Merged
merged 21 commits into from Jul 23, 2019

Conversation

@klaudiagrz
Copy link
Contributor

klaudiagrz commented Jul 3, 2019

Description

Changes proposed in this pull request:

  • Update Helm Broker documentation with the description of AddonsConfiguration
klaudiagrz added 4 commits Jul 4, 2019
@klaudiagrz klaudiagrz added WIP and removed WIP labels Jul 11, 2019
klaudiagrz added 4 commits Jul 11, 2019
@klaudiagrz klaudiagrz removed the WIP label Jul 16, 2019
docs/helm-broker/02-02-deep-dive.md Outdated Show resolved Hide resolved
docs/helm-broker/02-02-deep-dive.md Outdated Show resolved Hide resolved
docs/helm-broker/02-02-deep-dive.md Outdated Show resolved Hide resolved
docs/helm-broker/02-02-deep-dive.md Outdated Show resolved Hide resolved
docs/helm-broker/02-02-deep-dive.md Outdated Show resolved Hide resolved
docs/helm-broker/06-01-clusteraddonsconfiguration.md Outdated Show resolved Hide resolved
docs/helm-broker/08-01-fetch-remote-addons.md Outdated Show resolved Hide resolved
docs/helm-broker/08-01-fetch-remote-addons.md Outdated Show resolved Hide resolved
klaudiagrz added 4 commits Jul 18, 2019
Copy link
Contributor

tomekpapiernik left a comment

Use H2s instead of H3s in docs which use only one heading level!

docs/helm-broker/01-01-helm-broker.md Outdated Show resolved Hide resolved

The Helm Broker fetches bundles which contain a set of specific [files](#details-create-a-bundle). You must place your bundles in a repository of an appropriate [format](#details-create-a-bundles-repository). By default, the Helm Broker fetches bundles from the release of the [`bundles`](https://github.com/kyma-project/bundles/releases) repository. You can also [configure](#tutorials-tutorials) the Helm Broker to fetch bundle definitions from any remote HTTP or HTTPS server.
The Helm Broker fetches addons which contain a set of specific [files](#details-create-addons). You must place your addons in a repository of an appropriate [format](#details-create-addons-repository). The Helm Broker fetches default cluster-wide addons defined by the [helm-repos-urls](#link) custom resource (CR). This CR contains URLs that point to the release of [`addons`](https://github.com/kyma-project/bundles/releases) repository compatible with a given [Kyma release](https://github.com/kyma-project/kyma/releases). You can also [configure](#details-fetch-addons-from-https-servers) the Helm Broker to fetch addons definitions from any remote HTTP or HTTPS server.

This comment has been minimized.

Copy link
@tomekpapiernik

tomekpapiernik Jul 19, 2019

Contributor
Suggested change
The Helm Broker fetches addons which contain a set of specific [files](#details-create-addons). You must place your addons in a repository of an appropriate [format](#details-create-addons-repository). The Helm Broker fetches default cluster-wide addons defined by the [helm-repos-urls](#link) custom resource (CR). This CR contains URLs that point to the release of [`addons`](https://github.com/kyma-project/bundles/releases) repository compatible with a given [Kyma release](https://github.com/kyma-project/kyma/releases). You can also [configure](#details-fetch-addons-from-https-servers) the Helm Broker to fetch addons definitions from any remote HTTP or HTTPS server.
The Helm Broker fetches addons which contain a set of specific [files](#details-create-addons). You must place your addons in a repository that has a set [structure](#details-create-addons-repository). The Helm Broker fetches the default cluster-wide addons defined by the [helm-repos-urls](#link) custom resource (CR). This CR contains URLs that point to the release of [`addons`](https://github.com/kyma-project/bundles/releases) repository compatible with the given [Kyma release](https://github.com/kyma-project/kyma/releases). You can also [configure](#details-fetch-addons-from-https-servers) the Helm Broker to fetch addons definitions from any remote HTTP or HTTPS server.

This comment has been minimized.

Copy link
@tomekpapiernik

tomekpapiernik Jul 19, 2019

Contributor

(...) by the [helm-repos-urls](#link) custom resource (CR)
I guess you want to fix this? :p

This comment has been minimized.

Copy link
@klaudiagrz

klaudiagrz Jul 19, 2019

Author Contributor

Yup, I'll add the link after the Controller is merged.

docs/helm-broker/01-01-helm-broker.md Outdated Show resolved Hide resolved
docs/helm-broker/02-01-helm-broker.md Outdated Show resolved Hide resolved

### Registration process
If you want the Helm Broker to act as a Namespace-scoped ServiceBroker, create the [AddonsConfiguration](#custom-resource-addonsconfiguration) (AC) custom resource. In such a case, the Helm Broker creates a service and registers itself in the Service Catalog as a ServiceBroker inside the Namespace in which the CR is created.

This comment has been minimized.

Copy link
@tomekpapiernik

tomekpapiernik Jul 19, 2019

Contributor

ServiceBroker -
I'm not sure if you should explain that it is "Namespace-scoped". You used ClusterServiceBroker earlier and you don't explain that it's cluster-wide. So either explain this difference for both cases or link to external docs that indicate what each of these types is.

This comment has been minimized.

Copy link
@klaudiagrz

klaudiagrz Jul 19, 2019

Author Contributor

It's just one word, I'd rather leave it the way it is, just to be clear.

This comment has been minimized.

Copy link
@tomekpapiernik
docs/helm-broker/06-01-clusteraddonsconfiguration.md Outdated Show resolved Hide resolved
docs/helm-broker/06-01-clusteraddonsconfiguration.md Outdated Show resolved Hide resolved
docs/helm-broker/06-02-addonsconfiguration.md Outdated Show resolved Hide resolved
docs/helm-broker/06-02-addonsconfiguration.md Outdated Show resolved Hide resolved
docs/helm-broker/06-02-addonsconfiguration.md Outdated Show resolved Hide resolved
Co-Authored-By: Tomasz Papiernik <tomasz.papiernik@sap.com>
klaudiagrz and others added 5 commits Jul 19, 2019
Co-Authored-By: Tomasz Papiernik <tomasz.papiernik@sap.com>
Co-Authored-By: Tomasz Papiernik <tomasz.papiernik@sap.com>
Co-Authored-By: Tomasz Papiernik <tomasz.papiernik@sap.com>
@klaudiagrz

This comment has been minimized.

Copy link
Contributor Author

klaudiagrz commented Jul 22, 2019

/test kyma-governance

1 similar comment
@klaudiagrz

This comment has been minimized.

Copy link
Contributor Author

klaudiagrz commented Jul 23, 2019

/test kyma-governance

@klaudiagrz

This comment has been minimized.

Copy link
Contributor Author

klaudiagrz commented Jul 23, 2019

/retest

@klaudiagrz klaudiagrz merged commit c8142ec into kyma-project:master Jul 23, 2019
100 checks passed
100 checks passed
kyma-governance Job succeeded.
Details
kyma-metadata-schema-governance Skipped.
license/cla Contributor License Agreement is signed.
Details
pre-master-kyma-backup-test Skipped.
pre-master-kyma-common Skipped.
pre-master-kyma-components-api-controller Skipped.
pre-master-kyma-components-apiserver-proxy Skipped.
pre-master-kyma-components-application-broker Skipped.
pre-master-kyma-components-application-connectivity-certs-setup-job Skipped.
pre-master-kyma-components-application-connectivity-validator Skipped.
pre-master-kyma-components-application-gateway Skipped.
pre-master-kyma-components-application-operator Skipped.
pre-master-kyma-components-application-registry Skipped.
pre-master-kyma-components-asset-metadata-service Skipped.
pre-master-kyma-components-asset-store-controller-manager Skipped.
pre-master-kyma-components-asset-upload-service Skipped.
pre-master-kyma-components-cms-controller-manager Skipped.
pre-master-kyma-components-compass-runtime-agent Skipped.
pre-master-kyma-components-connection-token-handler Skipped.
pre-master-kyma-components-connectivity-certs-controller Skipped.
pre-master-kyma-components-connector-service Skipped.
pre-master-kyma-components-console-backend-service Skipped.
pre-master-kyma-components-dex-static-user-configurer Skipped.
pre-master-kyma-components-etcd-tls-setup-job Skipped.
pre-master-kyma-components-event-bus Skipped.
pre-master-kyma-components-event-service Skipped.
pre-master-kyma-components-helm-broker Job succeeded.
Details
pre-master-kyma-components-iam-kubeconfig-service Skipped.
pre-master-kyma-components-istio-kyma-patch Skipped.
pre-master-kyma-components-k8s-dashboard-proxy Skipped.
pre-master-kyma-components-knative-function-controller Skipped.
pre-master-kyma-components-kubeless-images-nodejs Skipped.
pre-master-kyma-components-kyma-operator Skipped.
pre-master-kyma-components-namespace-controller Skipped.
pre-master-kyma-components-service-binding-usage-controller Skipped.
pre-master-kyma-components-xip-patch Skipped.
pre-master-kyma-development-artifacts Skipped.
pre-master-kyma-gke-backup Skipped.
pre-master-kyma-gke-central-connector Skipped.
pre-master-kyma-gke-integration Skipped.
pre-master-kyma-gke-minio-gateway Skipped.
pre-master-kyma-gke-minio-gateway-migration Skipped.
pre-master-kyma-gke-upgrade Skipped.
pre-master-kyma-integration Skipped.
pre-master-kyma-tests-acceptance Skipped.
pre-master-kyma-tests-application-connector-tests Skipped.
pre-master-kyma-tests-application-gateway-tests Skipped.
pre-master-kyma-tests-application-operator-tests Skipped.
pre-master-kyma-tests-application-registry-tests Skipped.
pre-master-kyma-tests-asset-store Skipped.
pre-master-kyma-tests-compass-runtime-agent Skipped.
pre-master-kyma-tests-connection-token-handler-tests Skipped.
pre-master-kyma-tests-connector-service-tests Skipped.
pre-master-kyma-tests-console-backend-service Skipped.
pre-master-kyma-tests-end-to-end-backup-restore-test Skipped.
pre-master-kyma-tests-end-to-end-external-solution-integration Skipped.
pre-master-kyma-tests-end-to-end-kubeless-integration Skipped.
pre-master-kyma-tests-end-to-end-upgrade Skipped.
pre-master-kyma-tests-event-bus Skipped.
pre-master-kyma-tests-integration-api-controller Skipped.
pre-master-kyma-tests-integration-apiserver-proxy Skipped.
pre-master-kyma-tests-integration-cluster-users Skipped.
pre-master-kyma-tests-integration-dex Skipped.
pre-master-kyma-tests-integration-event-service Skipped.
pre-master-kyma-tests-integration-gateway Skipped.
pre-master-kyma-tests-integration-logging Skipped.
pre-master-kyma-tests-integration-monitoring Skipped.
pre-master-kyma-tests-knative-build Skipped.
pre-master-kyma-tests-knative-serving Skipped.
pre-master-kyma-tests-kubeless Skipped.
pre-master-kyma-tests-test-namespace-controller Skipped.
pre-master-kyma-tools-alpine-net Skipped.
pre-master-kyma-tools-failery Skipped.
pre-master-kyma-tools-load-test Skipped.
pre-master-kyma-tools-velero-plugins Skipped.
pre-rel11-kyma-common Skipped.
pre-rel11-kyma-components-api-controller Skipped.
pre-rel11-kyma-components-apiserver-proxy Skipped.
pre-rel11-kyma-components-application-broker Skipped.
pre-rel11-kyma-components-application-gateway Skipped.
pre-rel11-kyma-components-application-operator Skipped.
pre-rel11-kyma-components-application-registry Skipped.
pre-rel11-kyma-components-asset-metadata-service Skipped.
pre-rel11-kyma-components-asset-store-controller-manager Skipped.
pre-rel11-kyma-components-asset-upload-service Skipped.
pre-rel11-kyma-components-binding-usage-controller Skipped.
pre-rel11-kyma-components-cms-controller-manager Skipped.
pre-rel11-kyma-components-connection-token-handler Skipped.
pre-rel11-kyma-components-connectivity-certs-controller Skipped.
pre-rel11-kyma-components-connector-service Skipped.
pre-rel11-kyma-components-console-backend-service Skipped.
pre-rel11-kyma-components-dex-static-user-configurer Skipped.
pre-rel11-kyma-components-event-bus Skipped.
pre-rel11-kyma-components-event-service Skipped.
pre-rel11-kyma-components-helm-broker Skipped.
pre-rel11-kyma-components-iam-kubeconfig-service Skipped.
pre-rel11-kyma-components-istio-kyma-patch Skipped.
pre-rel11-kyma-components-k8s-dashboard-proxy Skipped.
pre-rel11-kyma-components-knative-function-controller Skipped.
pre-rel11-kyma-components-kubeless-images-nodejs Skipped.
@klaudiagrz klaudiagrz deleted the klaudiagrz:4620 branch Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.