Skip to content

Commit

Permalink
Fixup private api markings across the line
Browse files Browse the repository at this point in the history
  • Loading branch information
ananace committed Sep 27, 2024
1 parent dfa82f4 commit 26e878f
Show file tree
Hide file tree
Showing 13 changed files with 291 additions and 1,813 deletions.
2,087 changes: 274 additions & 1,813 deletions REFERENCE.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions manifests/common.pp
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# @summary Sets up common Kubernetes components - users/groups/folders/etc
# @api private
class k8s::common {
assert_private()

group { $k8s::group:
ensure => present,
system => true,
Expand Down
1 change: 1 addition & 0 deletions manifests/node/kube_proxy.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Sets up a on-node kube-proxy instance
# @api private
#
# For most use-cases, running kube-proxy inside the cluster itself is recommended
#
Expand Down
3 changes: 3 additions & 0 deletions manifests/node/kubelet.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Installs and configures kubelet
# @api private
#
# @param arguments additional arguments to pass to kubelet
# @param auth type of node authentication
Expand Down Expand Up @@ -52,6 +53,8 @@

Optional[K8s::Firewall] $firewall_type = $k8s::node::firewall_type,
) {
assert_private()

k8s::binary { 'kubelet':
ensure => $ensure,
notify => Service['kubelet'],
Expand Down
1 change: 1 addition & 0 deletions manifests/server/apiserver.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Installs and configures a Kubernetes apiserver
# @api private
#
# @param advertise_address bind address of the apiserver
# @param aggregator_ca_cert path to the aggregator ca cert file
Expand Down
1 change: 1 addition & 0 deletions manifests/server/controller_manager.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Installs and configures a Kubernetes controller manager
# @api private
#
# @param arguments Additional arguments to pass to the controller manager.
# @param ca_cert The path to the CA certificate.
Expand Down
1 change: 1 addition & 0 deletions manifests/server/resources.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates and deploys standard Kubernetes in-cluster services
# @api private
#
# @param ca_cert the path to the CA certificate to use for the cluster
# @param cluster_cidr the CIDR to use for the cluster
Expand Down
1 change: 1 addition & 0 deletions manifests/server/resources/bootstrap.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates and deploys the default Puppet boostrap configuration into the cluster
# @api private
#
# @param control_plane_url The main API URL to encode in the bootstrap configuration
# @param ensure Whether the resources should be present or absent
Expand Down
1 change: 1 addition & 0 deletions manifests/server/resources/coredns.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates and deploys the default CoreDNS DNS provider for Kubernetes
# @api private
#
# @param cluster_domain The cluster domain to use for the CoreDNS ConfigMap
# @param corefile_content The content to use for the CoreDNS ConfigMap
Expand Down
1 change: 1 addition & 0 deletions manifests/server/resources/flannel.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates and deploys the default CoreDNS DNS provider for Kubernetes
# @api private
#
# @param cluster_cidr The internal cluster CIDR to proxy for
# @param cni_image The Flannel CNI plugin image name to use
Expand Down
1 change: 1 addition & 0 deletions manifests/server/resources/kube_proxy.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates and deploys the default kube-proxy service for Kubernetes
# @api private
#
# @param cluster_cidr The internal cluster CIDR to proxy for
# @param daemonset_config Additional configuration to merge into the DaemonSet object
Expand Down
1 change: 1 addition & 0 deletions manifests/server/scheduler.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Installs and configures a Kubernetes scheduler
# @api private
#
# @param ensure Whether the scheduler should be configured.
# @param control_plane_url The URL of the Kubernetes API server.
Expand Down
2 changes: 2 additions & 0 deletions manifests/server/tls.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# @summary Generates the necessary Kubernetes certificates for a server
# @api private
#
# @param aggregator_ca_cert The path to the aggregator CA certificate
# @param aggregator_ca_key The path to the aggregator CA key
Expand Down Expand Up @@ -32,6 +33,7 @@
Stdlib::Unixpath $aggregator_ca_key = $k8s::server::aggregator_ca_key,
Stdlib::Unixpath $aggregator_ca_cert = $k8s::server::aggregator_ca_cert,
) {
assert_private()
if $manage_certs or $ensure == 'absent' {
if !defined(File[$cert_path]) {
file { $cert_path:
Expand Down

0 comments on commit 26e878f

Please sign in to comment.