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

Added shout-out section to README.md #141

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ kube-fledged provides CRUD APIs to manage the lifecycle of the image cache, and
- [Built With](#built-with)
- [Contributing](#contributing)
- [License](#license)
- [Shout-outs](#shout-outs)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -364,3 +365,16 @@ Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of
## License

This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details

## Shout-outs:
[Cloud-Native Through the Prism of Percona
Episode 1 :](https://www.percona.com/blog/cloud-native-series-1)

-https://www.percona.com/blog/cloud-native-series-1
-https://collabnix.github.io/kubetools/
-https://itnext.io/kubernetes-essential-tools-2021-def12e84c572
-https://learnk8s.io/kubernetes-autoscaling-strategies
-https://www.libhunt.com/r/kraken
-https://dev.to/ajeetraina/top-200-kubernetes-tools-for-devops-engineer-like-you-3h7e
-https://www.facebook.com/groups/kubernetes.professionals/posts/1055140111994964/
-https://www.reddit.com/r/kubernetes/comments/pxbdkj/kubefledged_cache_container_images_in_kubernetes/
59 changes: 59 additions & 0 deletions deploy/kubefledged-operator/helm-charts/kubefledged/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Kube-Fledged helm chart

## Short description of Kube-fledged


Kube-fledged is a kubernetes operator for creating and managing a cache of container images directly on the worker nodes of a kubernetes cluster. It allows a user to define a list of images and onto which worker nodes those images should be cached (i.e. pulled). As a result, application pods start almost instantly, since the images need not be pulled from the registry. kube-fledged provides CRUD APIs to manage the lifecycle of the image cache, and supports several configurable parameters to customize the functioning as per one's needs.

## How to install the chart


- Create the namespace where kube-fledged will be installed

```
$ export KUBEFLEDGED_NAMESPACE=kube-fledged
$ kubectl create namespace ${KUBEFLEDGED_NAMESPACE}
```

- Verify and install latest version of kube-fledged helm chart

```
$ helm repo add kubefledged-charts https://senthilrch.github.io/kubefledged-charts/
$ helm repo update
$ gpg --keyserver keyserver.ubuntu.com --recv-keys 92D793FA3A6460ED (or) gpg --keyserver pgp.mit.edu --recv-keys 92D793FA3A6460ED
$ gpg --export >~/.gnupg/pubring.gpg
$ helm install --verify kube-fledged kubefledged-charts/kube-fledged -n ${KUBEFLEDGED_NAMESPACE} --wait
```

- Optional: Verify and install kube-fledged webhook server. This component enables validating the ImageCache CR.

```
$ helm upgrade --verify kube-fledged kubefledged-charts/kube-fledged -n ${KUBEFLEDGED_NAMESPACE} --set webhookServer.enable=true --wait
```

## Chart parameters


| Parameter | Default value | Description |
| --------- | ------------- | ----------- |
| controllerReplicaCount | 1 | No. of replicas of kubefledged-controller |
| webhookServerReplicaCount | 1 | No. of replicas of kubefledged-webhook-server |
| controller.hostNetwork | false | When set to "true", kubefledged-controller pod runs with "hostNetwork: true" |
| webhookServer.enable | false | When set to "true", kubefledged-webhook-server is installed |
| webhookServer.hostNetwork | false | When set to "true", kubefledged-webhook-server pod runs with "hostNetwork: true" |
| image.kubefledgedControllerRepository | docker.io/senthilrch/kubefledged-controller | Repository name of kubefledged-controller image |
| image.kubefledgedCRIClientRepository | docker.io/senthilrch/kubefledged-cri-client | Repository name of kubefledged-cri-client image |
| image.kubefledgedWebhookServerRepository | docker.io/senthilrch/kubefledged-webhook-server | Repository name of kubefledged-webhook-server image |
| image.pullPolicy | Always | Image pull policy for kubefledged-controller and kubefledged-webhook-server pods |
| args.controllerLogLevel | INFO | Log level of kubefledged-controller |
| args.controllerImagePullDeadlineDuration | 5m | Maximum duration allowed for pulling an image. After this duration, image pull is considered to have failed |
| args.controllerImageCacheRefreshFrequency | 15m | The image cache is refreshed periodically to ensure the cache is up to date. Setting this flag to "0s" will disable refresh |
| args.controllerImagePullPolicy | IfNotPresent | Image pull policy for pulling images into and refreshing the cache. Possible values are 'IfNotPresent' and 'Always'. Default value is 'IfNotPresent'. Image with no or ":latest" tag are always pulled |
| args.controllerServiceAccountName | "" | serviceAccountName used in Jobs created for pulling or deleting images. Optional flag. If not specified the default service account of the namespace is used |
| args.webhookServerLogLevel | INFO | Log level of kubefledged-webhook-server |
| args.webhookServerCertFile | /var/run/secrets/webhook-server/tls.crt | Path of server certificate of kubefledged-webhook-server |
| args.webhookServerKeyFile | /var/run/secrets/webhook-server/tls.key | Path of server key of kubefledged-webhook-server |
| args.webhookServerPort | 443 | Listening port of kubefledged-webhook-server |
| nameOverride | "" | nameOverride replaces the name of the chart in Chart.yaml, when this is used to construct Kubernetes object names |
| fullnameOverride | "" | fullnameOverride completely replaces the generated name |
| | | |