diff --git a/cmd/config-generation/kubeconfig.go b/cmd/config-generation/kubeconfig.go index f1199097e..2eeae5217 100644 --- a/cmd/config-generation/kubeconfig.go +++ b/cmd/config-generation/kubeconfig.go @@ -13,6 +13,7 @@ // limitations under the License. // +// this generates kubeconfig file for multus based on service account package main import ( diff --git a/cmd/controller/main.go b/cmd/controller/main.go index 634bef5b8..ee2c533f3 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -13,6 +13,8 @@ // limitations under the License. // +// this is daemonized entrypoint process. which watches master config +// and generate multus CNI config package main import ( diff --git a/cmd/main.go b/cmd/main.go index 79e69f82c..294e028e6 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -15,7 +15,6 @@ // This is a "Multi-plugin".The delegate concept referred from CNI project // It reads other plugin netconf, and then invoke them, e.g. // flannel or sriov plugin. - package main import ( diff --git a/pkg/checkpoint/doc.go b/pkg/checkpoint/doc.go new file mode 100644 index 000000000..b4c9052d9 --- /dev/null +++ b/pkg/checkpoint/doc.go @@ -0,0 +1,17 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package checkpoint is the package that contains the libraries that manipulates kubelet's +// checkpoint API +package checkpoint diff --git a/pkg/config/doc.go b/pkg/config/doc.go new file mode 100644 index 000000000..54de07fe9 --- /dev/null +++ b/pkg/config/doc.go @@ -0,0 +1,17 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package config is the package that contains multus cni config related +// utilities. +package config diff --git a/pkg/k8sclient/doc.go b/pkg/k8sclient/doc.go new file mode 100644 index 000000000..9c8df4b10 --- /dev/null +++ b/pkg/k8sclient/doc.go @@ -0,0 +1,16 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package k8sclient is the package that contains the Kubernetes client libraries. +package k8sclient diff --git a/pkg/kubeletclient/doc.go b/pkg/kubeletclient/doc.go new file mode 100644 index 000000000..2b020cb3f --- /dev/null +++ b/pkg/kubeletclient/doc.go @@ -0,0 +1,17 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package kubeletclient is the package that contains the kubelet's libraries that +// controls podresource API in kubelet +package kubeletclient diff --git a/pkg/logging/doc.go b/pkg/logging/doc.go new file mode 100644 index 000000000..1e3fe3fec --- /dev/null +++ b/pkg/logging/doc.go @@ -0,0 +1,16 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package logging is the package that contains logging library. +package logging diff --git a/pkg/multus/doc.go b/pkg/multus/doc.go new file mode 100644 index 000000000..a2c83e62a --- /dev/null +++ b/pkg/multus/doc.go @@ -0,0 +1,17 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package multus is the package that contains main multus function, which +// manipulates CNI request for delegate plugins. +package multus diff --git a/pkg/netutils/doc.go b/pkg/netutils/doc.go new file mode 100644 index 000000000..77b1054f4 --- /dev/null +++ b/pkg/netutils/doc.go @@ -0,0 +1,16 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package netutils is the package that contains network related utilities. +package netutils diff --git a/pkg/testing/doc.go b/pkg/testing/doc.go new file mode 100644 index 000000000..828906588 --- /dev/null +++ b/pkg/testing/doc.go @@ -0,0 +1,16 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package testing is the package that contains unit-test libraries. +package testing diff --git a/pkg/types/doc.go b/pkg/types/doc.go new file mode 100644 index 000000000..010cbe129 --- /dev/null +++ b/pkg/types/doc.go @@ -0,0 +1,16 @@ +// Copyright (c) 2021 Multus Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package types contains common types in the multus. +package types