Skip to content
This repository has been archived by the owner on Nov 22, 2024. It is now read-only.

Deploying to Minikube docs #970

Merged
merged 2 commits into from
Jan 27, 2021

Conversation

leozilla
Copy link
Contributor

What changes were proposed in this pull request?

Documentation howto deploy an application to Minikube.
Refers to: #967

Why are the changes needed?

No documentation for this was present and its not trivial to find out how to deploy to Minikube.

Does this PR introduce any user-facing change?

Yes, its adding Documentation.

How was this patch tested?

By creating the docs locally and checking it manually.

There is still one thing left which does not work:

  • I tried to add the page to the navigation bar (on the left side) but it does not show up in the locally generated docs. I don't know why this does not work as it looks pretty straight forward to do this.

Input on the documentation is highly appreciated.

@leozilla
Copy link
Contributor Author

@andreaTP can u please have a look?


* Enable insecure registries in Minikube.
* Enable the `registry` Minikube addon.
* Configure Docker ot use the insecure registry.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Configure Docker ot use the insecure registry.
* Configure Docker to use the insecure registry.


Configure Docker to use the Minikube registry as insecure registry by adding it to
the `daemon.json` file, whose default location is `/etc/docker/daemon.json` on Linux.
If the `daemon.json` file does not exist, create it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add some information on how to do this for Windows / Mac, some details here: https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry (and probably smart to link to this page)

the `daemon.json` file, whose default location is `/etc/docker/daemon.json` on Linux.
If the `daemon.json` file does not exist, create it.

Replace `MINIKUBE_IP` with the actual Minikube VM ip obtained via `Minikube ip`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Replace `MINIKUBE_IP` with the actual Minikube VM ip obtained via `Minikube ip`.
Replace `MINIKUBE_IP` with the actual Minikube VM ip obtained via `minikube ip`.

docker push $(minikube ip):5000/sensor-data-scala:0.1

At this point, the Docker image containing the streamlets has been published to the Minikube Docker registry.
The `sensor-data-scala.json` file that the build produces contains the application descriptor.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `sensor-data-scala.json` file that the build produces contains the application descriptor.
The `sensor-data-scala.json` file that the build produces, contains the application descriptor.

Copy link
Contributor

@RayRoestenburg RayRoestenburg left a comment

Choose a reason for hiding this comment

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

Some minor comments and suggestions. otherwise good to go, thanks @leozilla !

@leozilla
Copy link
Contributor Author

@RayRoestenburg thanks for the fast feedback! I just incorporated your suggestions.
Did u also have a look if I configured the nav panel correctly? Cos locally on my machine this does not show the link to the Minikube page.

@RayRoestenburg
Copy link
Contributor

RayRoestenburg commented Jan 27, 2021

You can check the docs with make local-preview in docs directory, point browser to http://localhost:8000/docs/dev/index.html. is shows up like this in nav panel:

image

which looks good to me for now.
The existing 'deploy to kubernetes cluster' is part of the getting started doc.
It's probably nice to have this info under "Developing Cloudflow Applications", as well outside of the getting started guide, describing deployment aspects in general.

@RayRoestenburg RayRoestenburg marked this pull request as ready for review January 27, 2021 14:59
@RayRoestenburg
Copy link
Contributor

Thanks @leozilla !

@RayRoestenburg RayRoestenburg merged commit 27cd76b into lightbend:master Jan 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants