kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
minikube/docs/addons.md

49 lines
2.9 KiB
Markdown
Raw Normal View History

Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
## Add-ons
Fix typo, grammar, punctuations and formatting
2017-06-16 12:26:51 +00:00
Minikube has a set of built in addons that can be used enabled, disabled, and opened inside of the local k8s environment. Below is an example of this functionality for the `heapster` addon:
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
```shell
$ minikube addons list
Reflect current state for addons in addons.md
2017-11-04 09:26:56 +00:00
- registry: disabled
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
- registry-creds: disabled
Add freshpod as a new addon
2018-01-12 14:57:32 +00:00
- freshpod: disabled
Reflect current state for addons in addons.md
2017-11-04 09:26:56 +00:00
- addon-manager: enabled
Add freshpod as a new addon
2018-01-12 14:57:32 +00:00
- dashboard: enabled
Reflect current state for addons in addons.md
2017-11-04 09:26:56 +00:00
- heapster: disabled
- efk: disabled
- ingress: disabled
Add freshpod as a new addon
2018-01-12 14:57:32 +00:00
- default-storageclass: enabled
- storage-provisioner: enabled
Add storage-provisioner-gluster addon With this addon dynamic provisioning based on Gluster can be enabled: $ minikube addons enable storage-provisioner-gluster This will deploy several pods in a new 'storage-gluster' namespace: - glusterfs, storage service with a 10GB sparse /srv/fake-disk.img - heketi, a smart Gluster volume manager - glusterfile-provisioner, external-storage provisioner In addition, the StorageClass 'glusterfile' will be created. It is currently not configured as default StorageClass, so PVCs need to refer to the new StorageClass.
2018-08-08 18:29:43 +00:00
- storage-provisioner-gluster: disabled
Add nvidia-driver-installer and nvidia-gpu-device-plugin addons.
2018-06-26 00:11:24 +00:00
- nvidia-driver-installer: disabled
- nvidia-gpu-device-plugin: disabled
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
# minikube must be running for these commands to take effect
$ minikube addons enable heapster
heapster was successfully enabled
$ minikube addons open heapster # This will open grafana (interacting w/ heapster) in the browser
Waiting, endpoint for service is not ready yet...
Waiting, endpoint for service is not ready yet...
Created new window in existing browser session.
```
The currently supported addons include:
* [Kubernetes Dashboard](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/dashboard)
* [Heapster](https://github.com/kubernetes/heapster): [Troubleshooting Guide](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md) Note:You will need to login to Grafana as admin/admin in order to access the console
Add addon support for EFK logging
2017-11-01 17:00:38 +00:00
* [EFK](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/fluentd-elasticsearch)
docs: update registry doc link
2018-02-10 22:52:05 +00:00
* [Registry](https://github.com/kubernetes/minikube/tree/master/deploy/addons/registry)
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
* [Registry Credentials](https://github.com/upmc-enterprises/registry-creds)
Reflect current state for addons in addons.md
2017-11-04 09:26:56 +00:00
* [Ingress](https://github.com/kubernetes/ingress-nginx)
Add freshpod as a new addon
2018-01-12 14:57:32 +00:00
* [Freshpod](https://github.com/GoogleCloudPlatform/freshpod)
Add nvidia-driver-installer and nvidia-gpu-device-plugin addons.
2018-06-26 00:11:24 +00:00
* [nvidia-driver-installer](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/nvidia-driver-installer/minikube)
* [nvidia-gpu-device-plugin](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/cmd/nvidia_gpu)
Initial commit of logviewer addon
2018-12-02 20:58:06 +00:00
* [logviewer](https://github.com/ivans3/minikube-log-viewer)
Enable gvisor addon in minikube (#3399) This PR adds the code for enabling gvisor in minikube. It adds the pod that will run when the addon is enabled, and the code for the image which will run when this happens. When gvisor is enabled, the pod will download runsc and the gvisor-containerd-shim. It will replace the containerd config.toml and restart containerd. When gvisor is disabled, the pod will be deleted by the addon manager. This will trigger a pre-stop hook which will revert the config.toml to it's original state and restart containerd.
2018-12-07 23:27:22 +00:00
* [gvisor](../deploy/addons/gvisor/README.md)
Add storage-provisioner-gluster addon With this addon dynamic provisioning based on Gluster can be enabled: $ minikube addons enable storage-provisioner-gluster This will deploy several pods in a new 'storage-gluster' namespace: - glusterfs, storage service with a 10GB sparse /srv/fake-disk.img - heketi, a smart Gluster volume manager - glusterfile-provisioner, external-storage provisioner In addition, the StorageClass 'glusterfile' will be created. It is currently not configured as default StorageClass, so PVCs need to refer to the new StorageClass.
2018-08-08 18:29:43 +00:00
* [storage-provisioner-gluster](../deploy/addons/storage-provisioner-gluster/README.md)
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
Fix typo, grammar, punctuations and formatting
2017-06-16 12:26:51 +00:00
If you would like to have minikube properly start/restart custom addons, place the addon(s) you wish to be launched with minikube in the `.minikube/addons` directory. Addons in this folder will be moved to the minikube VM and launched each time minikube is started/restarted.
Refactor docs Summary of changes (#1364) * README.md split up into specific tutorials in ./docs * brew as preferred installation on macOS * installation guide on README * minikube iso changelog merged with minikube changelog * developer guides moved to ./docs/contributors * no relative links on main README, so that we can port this over to kubernetes.io * ISO developer readme moved to ./docs/contributors
2017-05-03 21:53:51 +00:00
Fix reference to ADD_ADDON.md
2017-05-17 15:27:12 +00:00
If you have a request for an addon in minikube, please open an issue with the name and preferably a link to the addon with a description of its purpose and why it should be added. You can also attempt to add the addon to minikube by following the guide at [Adding an Addon](contributors/adding_an_addon.md)
note about plugin default config Added note about where to find plugin configuration.
2018-03-08 09:14:58 +00:00
**Note:** If you want to have a look at the default configuration for the addons, see [deploy/addons](https://github.com/kubernetes/minikube/tree/master/deploy/addons).