yc-alb-ingress-controller

README

Ingress Controller

Pull Requests

Please ensure all changes are documented using Changie when submitting a PR.

Environment

Instead of explicitly passing variables to make targets, you can use .env files

cp .env.example .env

Deployment

Requirements

• docker
• s3cmd
• go >= 1.17

Prerequisites

1. Configure container registry authentication and access. At the moment only Yandex Container Registry is supported
2. Build and push ingress controller image

make docker-build REGISTRY_ID=<registry_id>  
make docker-push REGISTRY_ID=<registry_id> 

1. With ycp, create 2 ipv6 yandex-only ip addresses. One will be used for load balancer, another one will be used to communicate with dualstack cluster.
2. Create dns AAAA record for alb ip address. It is needed for grpc tests

Note: image name will be set to cr.yandex/${REGISTRY_ID}/yc-alb-ingress-controller:$(git rev-parse HEAD)
5. Create an authorized service account key. Instructions.
This account will be used by controller to create/update balancer, it must have following roles: editor on the load-balancer(s) folder certificate-manager.certificates.downloader on the TLS certificates folder 6. Set environment variables or pass them with the Makefile commands as in the example below:

Environment variables

FOLDER_ID - folder for ingress controller cloud resources
KEY_FILE - path to the authorized service account key (sa-key.json) REGISTRY_ID - container registry with controller images 7. 8.Install CRD into K8s cluster

make install

Deploy command example:

make deploy FOLDER_ID=b1gao62h0ixxxxxxxxxx KEY_FILE=${HOME}/sa/key.json REGISTRY_ID=crp3164es1xxxxxxxxxx

Undeploy command example:

make undeploy FOLDER_ID=b1gao62h0ixxxxxxxxxx KEY_FILE=${HOME}/sa/key.json

(It will remove the ingress controller from K8s cluster and delete deployment patches made by kustomize)

Development

About generated filed and kubebuilder

1. api/v1alpha1/zz_generated.deepcopy.go is generated. You can generate is with make generate
2. All files in the config/crd/bases/ directory are generated. To generate them, use make manifests.
   These files are CRDs generated from .go files in api/v1alpha1/
3. The file config/rbac/role.yaml is also generated. You can generate it with make manifests
4. Many files in config/ are generated by kubebuilder during project initialization. A lot of them are not used and have comments "Not used at the moment".
5. There are some ConfigMap/data variables in config/manager/kustomization.yaml. They are supposed to be injected by make patch
6. Do not remove the comments // +kubebuilder:scaffold from files. These comments are used by kubebuilder to add new code.

Documentation

Overview

Copyright 2024.

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.