Installing Gateway API

Gateway API is a collection of API resources that model network communications in a Managed Service for Kubernetes cluster, including GatewayClass, Gateway, HTTPRoute, etc.

In Managed Service for Kubernetes, Gateway API launches Yandex Application Load Balancer and its auxiliary resources when a Kubernetes user announces the Gateway resource in a Managed Service for Kubernetes cluster.

Getting startedGetting started

1. If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

   By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

2. Create a service account required for Gateway API.

3. Assign the following roles to the service account:

   • alb.editor: To create resources.
   • vpc.publicAdmin: To manage external connectivity.
   • certificate-manager.admin: To use certificates registered in Yandex Certificate Manager.
   • compute.viewer: To use Managed Service for Kubernetes cluster nodes in balancer target groups.

4. Create an authorized key for your service account and save it to the sa-key.json file:

   yc iam key create \
     --service-account-name <name_of_service_account_for_Gateway_API> \
     --output sa-key.json
   

5. Make sure that the security groups for the Managed Service for Kubernetes cluster and its node groups are configured correctly. If any rule is missing, add it.

   Warning

   The configuration of security groups determines the performance and availability of the cluster and the services and applications running in it.

Installation using Yandex Cloud MarketplaceInstallation using Yandex Cloud Marketplace

1. Navigate to the folder dashboard and select Managed Service for Kubernetes.
2. Click the name of the Managed Service for Kubernetes cluster you need and select the Marketplace tab.
3. Under Application available for installation, select Gateway API and click Go to install.
4. Configure the application:
   • Namespace: Create a new namespace, e.g., gateway-api-space. If you leave the default namespace, Gateway API may work incorrectly.
   • Application name: Specify the application name.
   • Folder ID: Select the folder where you want to create your load balancers.
   • Network ID: Select the cloud network where your load balancers will reside.
   • Subnet ID 1, Subnet ID 2, Subnet ID 3: Select subnets where your load balancers will reside.
   • Service account key: Paste the contents of the sa-key.json file or create a new service account key.
5. Click Install.
6. Wait for the application to change its status to Deployed.

Installation using a Helm chartInstallation using a Helm chart

1. Install Helm v3.8.0 or higher.

2. Install kubect and configure it to work with the new cluster.

3. To install a Helm chart with Gateway API, run this command:

   helm pull oci://cr.yandex/yc-marketplace/yandex-cloud/gateway-api/gateway-api-helm/gateway-api \
     --version v0.7.2 \
     --untar && \
   helm install \
     --namespace <namespace> \
     --create-namespace \
     --set folderId='<folder_ID>' \
     --set networkId='<cloud_network_ID>' \
     --set subnet1Id='<subnet_1_ID>' \
     --set subnet2Id='<subnet_2_ID>' \
     --set subnet3Id='<subnet_3_ID>' \
     --set-file saKeySecretKey='<path_to_sa-key.json>' \
     gateway-api ./gateway-api/
   

   In this command, specify the network and its subnets where your load balancers will reside.

   If you set namespace to the default namespace, Gateway API may work incorrectly. We recommend that you specify a value different from all existing namespaces (e.g., gateway-api-space).

   Note

   If you are using a Helm version below 3.8.0, append the export HELM_EXPERIMENTAL_OCI=1 && \ string to the command to enable Open Container Initiative (OCI) support in the Helm client.

Application autoupdateApplication autoupdate

Gateway API 0.6.0 contains a Gateway API CRD upgrade from version 0.6.2 to 1.2.1. When upgrading your Gateway API from version 0.5.0 or lower to version 0.6.0, installing from the Helm chart will automatically upgrade Gateway API CRDs and all dependent resources in the Managed Service for Kubernetes cluster. The upgrade is secure, meaning that none of your Application Load Balancer resources will be deleted or recreated.

An autoupdate from version 0.5.0 or lower follows this procedure:

1. The cluster is checked for GRPCRoute or ReferenceGrant user resources. If it does, the update is blocked to avoid conflicts, as the new version CRDs for these resources are incompatible with the previous version. For manual updates, see below.
2. The Gateway API controller is stopped; the number of replicas is reduced to zero.
3. The CRDs of the GRPCRoute resources are removed; the CRDs of the remaining dependent resources of the new Gateway API version are applied.
4. The Gateway API controller is started; the number of replicas is back at the original level.

To disable CRD autoupdate, add this Helm chart installation command parameter: --set crdsAutoUpgrade=false. In which case your resources will be updated, but you will need to update the Gateway API CRDs manually. For the CRD file, go to the crds directory in the Helm chart archive.

Use casesUse cases

• Setting up Gateway API.

See alsoSee also

• Gateway API project description.
• Gateway API description and configuration information in the Application Load Balancer guides.