-
Notifications
You must be signed in to change notification settings - Fork 706
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
Added Service Catalog tutorial #988
Added Service Catalog tutorial #988
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content looks good to me! I have some minor suggestions.
the following: | ||
|
||
``` | ||
helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
don't you prefer to explain how to install the svc catalog through kubeapps?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, we include it by default, but maybe it's more steps to describe whereas the CLI commands are easy to copy
page regularly to check on the progress. Provisioning an Azure MySQL instance | ||
takes around 10-15 minutes. | ||
|
||
![Azure MySQL provisioning](../img/azure-mysql-provisioning.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be more helpful a screenshot of a successful provision, that way the users can compare if something has gone wrong.
docs/user/service-catalog.md
Outdated
to the Azure MySQL database: | ||
|
||
``` | ||
k logs wordpress-app-wordpress-597b9dbb5-2rk4k |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think is better to use the full kubectl
name here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍, clearer to use the full command name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops 🤣
Click on `Deploy` and modify the following values: | ||
|
||
``` | ||
env.open.STORAGE: google |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe it's better to copy here a YAML snippet that users can paste in Kubeapps directly? (instead of looking for the specific fields)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mmm, I am not sure. The problem is that in Kubeapps, the default behaviour (I believe) is to go through the values.yaml and replace the values you want to replace, rather than replacing the whole values.yaml. Those values are in very different places, so adding the full values.yaml would be too big. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, what I meant is, to avoid having to navigate through the whole values.yaml, tell the user something like:
Replace the default values.yaml with the following snippet and fill it with the values from the service binding:
env:
open:
STORAGE: google
STORAGE_GOOGLE_BUCKET: <name of the created bucket in the instance>
...
There is no need to specify the whole values.yaml, specifying just those fields will have the same effect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for writing this up, this is great! Just some grammatical stuff :)
docs/user/service-catalog.md
Outdated
|
||
## Service Catalog and Kubeapps | ||
|
||
Kubeapps has native integration with the Service Catalog and allow Kubeapps users |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kubeapps has native integration with the Service Catalog and allow Kubeapps users | |
Kubeapps has native integration with the Service Catalog and allows Kubeapps users |
docs/user/service-catalog.md
Outdated
|
||
In this tutorial we will explain how to deploy the Service Catalog into your cluster, | ||
we will configure two Service Brokers (GCP and Azure) and we will provision some | ||
cloud services that then will use in other applications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cloud services that then will use in other applications. | |
cloud services that we will then use in other applications. |
the following: | ||
|
||
``` | ||
helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, we include it by default, but maybe it's more steps to describe whereas the CLI commands are easy to copy
docs/user/service-catalog.md
Outdated
|
||
Once you have your account set up, follow the instructions at https://cloud.google.com/kubernetes-engine/docs/how-to/add-on/service-catalog/install-service-catalog. | ||
You can skip the part of deploying the Service Catalog (which we already deployed | ||
using the Helm Chart). Although the instructions mention GKE, those should work |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using the Helm Chart). Although the instructions mention GKE, those should work | |
using the Helm Chart). Although the instructions mention GKE, they should work |
docs/user/service-catalog.md
Outdated
be OK). Creating a new binding should be very fast. | ||
|
||
Once the binding creation has been completed, the details of the created | ||
secret can be explored directly from the same page, clicking on `show`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably add a note here telling the user to note down the credentials, as we'll use them in the next step.
docs/user/service-catalog.md
Outdated
to the Azure MySQL database: | ||
|
||
``` | ||
k logs wordpress-app-wordpress-597b9dbb5-2rk4k |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍, clearer to use the full command name
docs/user/service-catalog.md
Outdated
|
||
![Google Cloud Storage options](../img/gcp-storage-options.png) | ||
|
||
Once provisioned, we will add a binding clicking on `Add binding`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once provisioned, we will add a binding clicking on `Add binding`: | |
Once provisioned, click on `Add binding` to create a binding: |
docs/user/service-catalog.md
Outdated
![Google Cloud Storage binding options](../img/gcp-storage-binding-options.png) | ||
|
||
That will create a new service account in your GCP project with the right | ||
persmissions to access the bucket. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
persmissions to access the bucket. | |
permissions to access the bucket. |
docs/user/service-catalog.md
Outdated
persmissions to access the bucket. | ||
|
||
Once the binding creation has been completed, the details of the created | ||
secret can be explored directly from the same page, clicking on `show`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, we should probably tell the user to note down the credentials for the next step.
docs/user/service-catalog.md
Outdated
|
||
As ChartMuseum expects the format of the authentication information contained | ||
in the JSON, it is only needed to specify the key of the secret that contains | ||
that JSON (in our case `privateKeyData`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that JSON (in our case `privateKeyData`) | |
that JSON (in our case `privateKeyData`). |
Yes, what I mean is that if we only specify those values, people would be
confused, as I think in Kubeapps is more normal to replace values, rather
than the whole values.yaml
…On Wed, Mar 13, 2019 at 11:48 AM Andres Martinez Gotor < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/user/service-catalog.md
<#988 (comment)>:
> +privateKeyData: JSON with authantication details for the bucket
+projectId: the GCP project where the bucket was created
+serviceAccount: the service account to access the bucket
+```
+
+### Deploy Chartmuseum
+
+We will now deploy ChartMuseum, using Google Cloud Storage as backend.
+In the `Catalog` we will search for `chartmuseum`:
+
+![Searching ChartMuseum](../img/search-chartmuseum.png)
+
+Click on `Deploy` and modify the following values:
+
+```
+env.open.STORAGE: google
Yes, what I meant is, to avoid having to navigate through the whole
values.yaml, tell the user something like:
Replace the default values.yaml with the following snippet and fill it with the values from the service binding:
env:
open:
STORAGE: google
STORAGE_GOOGLE_BUCKET: <name of the created bucket in the instance>
...
There is no need to specify the whole values.yaml, specifying just those
fields will have the same effect.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#988 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AA4e_QLFT-xyg48jEM-nAWC0M2USKuXdks5vWNeCgaJpZM4bq56->
.
--
Ara Pulido
Engineering Manager, Bitnami
@arapulido
Migrate your applications to the cloud - package, migrate and maintain them
with Stacksmith <https://bitnami.com/stacksmith>.
Confidential - All Rights Reserved.
Bitnami © 2019
|
Added a how-to guide on installing and using the Service Catalog with Kubeapps.