Pin versions of debian packages (#86)

* Fix syntax a bit

* Change and update documentation a bit

* Rename `cni_version` to `cni_package_version` same way as `kubernetes_package_version`.

* Parametrize cni package name.

* Parametrize docker package name.

* Fix `docker_package_name` and `cni_package_name` variables.

* Update unit test because of parametrized docker cni package names.

* Update documentation and unit test because of `cni_package_version` change.

* Parametrize version of docker package to install and pin package for Debian/Ubuntu.

* Updated documentation

* Rename `cni_package_version` variable back to `cni_version` for back compatibility.

* `$docker_package_version` name typo fix

* Rename `docker_package_pin` variable to `package_pin`.

* Pin kube* packages

* Pin kubernetes-cni package

* Cover with unit tests

* Fix `docker_version`

Author: admont

README.md

@@ -142,6 +142,32 @@ The version the Kubernetes OS packages to install, such as kubectl and kubelet.
 
 Defaults to `1.9.2`.
 
+#### `docker_package_name`
+
+The name of the docker package you would like to install.
+
+Defaults to `docker-engine`.
+
+#### `docker_package_version`
+
+The version of the docker package you would like to install.
+
+Defaults depends on operating system.
+  - Red Hat: `1.12.6`
+  - Debian: `1.12.0`
+
+#### `package_pin`
+
+If you would like to pin versions of Docker and Kubernetes packages. Works only for Debian/Ubuntu.
+
+Defaults to `true`.
+
+#### `cni_package_name`
+
+The name of the cni package you would like to install.
+
+Defaults to `kubernetes-cni`.
+
 #### `cni_version`
 
 The version of the cni package to install.
@@ -438,13 +464,6 @@ Allows the user to override the label of a node.
 
 Defaults for hostname
 
-#### `docker_version`
-
-This is the version of the docker runtime that you want to install.
-
-Defaults to `1.12.6` on RedHat
-Defaults to `1.12.0-0~xenial` on Debian
-
 #### `kube_dns_version`
 
 The version of kube DNS you would like to install

manifests/init.pp

@@ -6,164 +6,183 @@
 # Parameters
 # ----------
 # [*kubernetes_version*]
-#   The version of Kubernetes containers you want to install.
-#   ie api server,
-#   Defaults to  1.9.2
+#   The version of Kubernetes containers you want to install - i.e. API server.
+#   Defaults to `1.9.2`.
 #
 # [*kubernetes_package_version*]
-#   The version of the packages the Kubernetes os packages to install
-#   ie kubectl and kubelet
-#   Defaults to 1.9.2
+#   The version of the packages the Kubernetes os packages to install - i.e.
+#   `kubectl` and `kubelet`.
+#   Defaults to `1.9.2`.
 #
-# [*container_runtime]
+# [*container_runtime*]
 #   This is the runtime that the Kubernetes cluster will use.
-#   It can only be set to "cri_containerd" or "docker"
-#   Defaults to docker
+#   It can only be set to `cri_containerd` or `docker`.
+#   Defaults to `docker`.
 #
-# [*docker_version]
-#   This is the version of the docker runtime that you want to install.
-#   Defaults to 1.12.6 on RedHat
-#   Defaults to 1.12.0-0~xenial on Debian
+# [*docker_package_name*]
+#   The name of the docker package you would like to install.
+#   Defaults to `docker-engine`.
+#
+# [*docker_package_version*]
+#   The version of the docker package you would like to install.
+#   Defaults depends on operating system.
+#     - Red Hat: `1.12.6`
+#     - Debian: `1.12.0`
+#
+# [*package_pin*]
+#   If you would like to pin versions of Docker and Kubernetes packages.
+#   Works only for Debian/Ubuntu.
+#   Defaults to `true`.
+#
+# [*cni_package_name*]
+#   The name of the cni package you would like to install.
+#   Defaults to `kubernetes-cni`.
 #
 # [*cni_version*]
-#   The version of the cni package you would like to install
-#   Defaults to 0.6.0
+#   The version of the cni package you would like to install.
+#   Defaults to `0.6.0`.
 #
-# [*cni_provider]
-#   The url location for the cni providers yaml. This can only be set to weave or flannel.
-#   Defaults to undef
+# [*cni_provider*]
+#   The url location for the cni providers yaml. This can only be set to `weave`
+#   or `flannel`.
+#   Defaults to `undef`.
 #
 # [*kube_dns_version*]
-#   The version of kube DNS you would like to install
-#   Defaults to 1.14.2
+#   The version of kube DNS you would like to install.
+#   Defaults to `1.14.2`.
 #
 # [*controller*]
-#   This is a bool that sets the node as a Kubernetes controller
-#   Defaults to false
+#   This is a bool that sets the node as a Kubernetes controller.
+#   Defaults to `false`.
 #
 # [*bootstrap_controller*]
-#   This sets the node to use as the bootstrap controller
-#   The bootstrap controller is only used for initial cluster creation
-#   Defaults to false
+#   This sets the node to use as the bootstrap controller.
+#   The bootstrap controller is only used for initial cluster creation.
+#   Defaults to `false`.
 #
 # [*bootstrap_controller_ip*]
 #   The ip address of the bootstrap controller.
-#   defaults to undef
+#   Defaults to `undef`.
 #
 # [*worker*]
 #   This is a bool that sets a node to a worker.
-#   defaults to undef
+#   Defaults to `undef`.
 #
 # [*kube_api_advertise_address*]
 #   This is the ip address that the want to api server to expose.
-#   An example with hiera would be kubernetes::kube_api_advertise_address: "%{::ipaddress_enp0s8}"
-#   defaults to undef
+#   An example with hiera would be `kubernetes::kube_api_advertise_address: "%{::ipaddress_enp0s8}"`.
+#   Defaults to `undef`.
+#
+# [*$apiserver_extra_arguments*]
+#   This is an array to pass extra configuration to the Kubernetes API.
+#   Defaults to `[]`.
 #
 # [*etcd_version*]
-#   The version of etcd that you would like to use.
-#   Defaults to 3.0.17
+#   The version of `etcd` that you would like to use.
+#   Defaults to `3.0.17`.
 #
 # [*etcd_ip*]
-#   The ip address that you want etcd to use for communications.
-#   An example with hiera would be kubernetes::etcd_ip: "%{::ipaddress_enp0s8}"
-#   Defaults to undef
+#   The ip address that you want `etcd` to use for communications.
+#   An example with hiera would be `kubernetes::etcd_ip: "%{::ipaddress_enp0s8}"`.
+#   Defaults to `undef`.
 #
 # [*etcd_initial_cluster*]
-#   This will tell etcd how many nodes will be in the cluster and is passed as a string.
-#   An example with hiera would be kubernetes::etcd_initial_cluster: etcd-kube-master=http://172.17.10.101:2380,etcd-kube-replica-master-01=http://172.17.10.210:2380,etcd-kube-replica-master-02=http://172.17.10.220:2380
-#   Defaults to undef
+#   This will tell `etcd` how many nodes will be in the cluster and is passed as a string.
+#   An example with hiera would be `kubernetes::etcd_initial_cluster: etcd-kube-master=http://172.17.10.101:2380,etcd-kube-replica-master-01=http://172.17.10.210:2380,etcd-kube-replica-master-02=http://172.17.10.220:2380`.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token*]
 #   This is the token Kubernetes will use to start components.
-#   For more information around bootstrap tokens please see https://kubernetes.io/docs/admin/bootstrap-tokens/
-#   Defaults to undef
+#   For more information around bootstrap tokens please see https://kubernetes.io/docs/admin/bootstrap-tokens/.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_name*]
 #   This is the name of the bootstrap token.
-#   An example with hiera would be kubernetes::bootstrap_token_name: bootstrap-token-95e1e0
-#   Defaults to undef
+#   An example with hiera would be `kubernetes::bootstrap_token_name: bootstrap-token-95e1e0`.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_description*]
 #   The boot strap token description, this must be base64 encoded.
 # lint:ignore:140chars
-#   An example with hierawould be  kubernetes::bootstrap_token_description: VGhlIGRlZmF1bHQgYm9vdHN0cmFwIHRva2VuIHBhc3NlZCB0byB0aGUgY2x1c3RlciB2aWEgUHVwcGV0Lg==
+#   An example with hierawould be `kubernetes::bootstrap_token_description: VGhlIGRlZmF1bHQgYm9vdHN0cmFwIHRva2VuIHBhc3NlZCB0byB0aGUgY2x1c3RlciB2aWEgUHVwcGV0Lg==`.
 # lint:endignore
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_id*]
 #   This is the id the cluster will use to point to the token, this must be base64 encoded.
-#   An example with hiera would be kubernetes::bootstrap_token_id: OTVlMWUwDQo=
-#   Defaults to undef
+#   An example with hiera would be `kubernetes::bootstrap_token_id: OTVlMWUwDQo=`.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_secret*]
 #   This is the secret to validate the boot strap token, this must be base64 encoded.
-#   An example with hiera would be kubernetes::bootstrap_token_secret: OTVlMWUwLmFlMmUzYjkwYTdmYjlkMzYNCg==
-#   Defaults to undef
+#   An example with hiera would be `kubernetes::bootstrap_token_secret: OTVlMWUwLmFlMmUzYjkwYTdmYjlkMzYNCg==`.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_usage_bootstrap_authentication*]
-#   This is the bool to use the boot strap token, this must be base64 encoded. (true = dHJ1ZQ==)
-#   An example with hiera would be kubernetes::bootstrap_token_usage_bootstrap_authentication: dHJ1ZQ==
-#   Defaults to undef
+#   This is the bool to use the boot strap token, this must be base64 encoded. (`true` = `dHJ1ZQ==`)
+#   An example with hiera would be `kubernetes::bootstrap_token_usage_bootstrap_authentication: dHJ1ZQ==`.
+#   Defaults to `undef`.
 #
 # [*bootstrap_token_usage_bootstrap_signing*]
-#   This is a bool to use boot trap signing, , this must be base64 encoded. (true = dHJ1ZQ==)
-#   An example with hiera would be kubernetes::bootstrap_token_usage_bootstrap_signing: dHJ1ZQ==
-#   Defaults to undef
+#   This is a bool to use boot trap signing, this must be base64 encoded. (`true` = `dHJ1ZQ==`)
+#   An example with hiera would be `kubernetes::bootstrap_token_usage_bootstrap_signing: dHJ1ZQ==`.
+#   Defaults to `undef`.
 #
 # [*certificate_authority_data*]
 #   This is the ca certificate data for the cluster. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_certificate_data_controller*]
 #   This is the client certificate data for the controllers. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_certificate_data_controller_manager*]
 #   This is the client certificate data for the controller manager. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_certificate_data_scheduler*]
 #   This is the client certificate data for the scheduler. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_certificate_data_worker*]
 #   This is the client certificate data for the kubernetes workers. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_key_data_controller*]
 #   This is the client certificate key for the controllers. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_key_data_controller_manager*]
 #   This is the client certificate key for the controller manager. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_key_data_scheduler*]
 #   This is the client certificate key for the scheduler. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*client_key_data_worker*]
 #   This is the client certificate key for the kubernetes workers. This must be passed as string not as a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*apiserver_kubelet_client_crt*]
 #   The kubelet api server certificate. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*apiserver_kubelet_client_key*]
 #   The kubelet api server key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*apiserver_crt*]
 #   The api server certificate. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*apiserver_key*]
 #   The api server key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*apiserver_extra_arguments*]
 #   A string array of extra arguments to be passed to the api server.
-#   Defaults to []
+#   Defaults to `[]`.
 #
 # [*apiserver_extra_volumes*]
 #   An array of objects describing additional volumes and volumeMounts to be configured in the api server pod. Each
@@ -172,40 +191,41 @@
 #
 # [*ca_crt*]
 #   The clusters ca certificate. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*ca_key*]
 #   The clusters ca key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*front_proxy_ca_crt*]
 #   The front proxy ca certificate. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*front_proxy_ca_key*]
 #   The front proxy ca key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*front_proxy_client_crt*]
 #   The front proxy client certificate. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*front_proxy_client_key*]
 #   The front proxy client key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*sa_key*]
 #   The service account key. Must be passed as cert not a file.
-#   Defaults to undef
+#   Defaults to `undef`.
 #
 # [*sa_pub*]
-#  The service account public key. Must be passed as cert not a file.
-#  Defaults to undef
+#   The service account public key. Must be passed as cert not a file.
+#   Defaults to `undef`.
 #
 # [*cni_network_provider*]
-#   This is the url that kubectl can find the networking deployment.
-#   We will support any networking provider that supports cni
-#   This defaults to https://git.io/weave-kube-1.6
+#   This is the url that `kubectl` can find the networking deployment - i.e.
+#   `https://git.io/weave-kube-1.6`.
+#   We will support any networking provider that supports cni.
+#   Defaults to `undef`.
 #
 # [*cni_cluster_cidr*]
 #   The overlay (internal) network range to use.
@@ -217,7 +237,7 @@
 #
 # [*install_dashboard*]
 #   This is a bool that determines if the kubernetes dashboard is installed.
-#   Defaults to false
+#   Defaults to `false`.
 #
 # [*kube_dns_ip*]
 #   The service IP to use for kube-dns.
@@ -244,7 +264,10 @@
   Optional[String] $kubernetes_package_version                     = $kubernetes::params::kubernetes_package_version,
   String $kubernetes_fqdn                                          = $kubernetes::params::kubernetes_fqdn,
   String $container_runtime                                        = $kubernetes::params::container_runtime,
-  Optional[String] $docker_version                                 = $kubernetes::params::docker_version,
+  Optional[String] $docker_package_name                            = $kubernetes::params::docker_package_name,
+  Optional[String] $docker_package_version                         = $kubernetes::params::docker_package_version,
+  Optional[Boolean] $package_pin                                   = $kubernetes::params::package_pin,
+  Optional[String] $cni_package_name                               = $kubernetes::params::cni_package_name,
   Optional[String] $cni_version                                    = $kubernetes::params::cni_version,
   Optional[String] $cni_cluster_cidr                               = $kubernetes::params::cni_cluster_cidr,
   Optional[Boolean] $cni_node_cidr                                 = $kubernetes::params::cni_node_cidr,