/oke-free

Uma maneira fácil de garantir seu próprio cluster Kubernetes gratuitamente e para sempre

Primary LanguageHCLGNU General Public License v3.0GPL-3.0

Criando um Cluster Kubernetes na OCI usando Terraform #MêsDoKubernetes

EM ATUALIZAÇÃO - VERIFIQUE A ISSUE #8 PARA MAIORES INFORMAÇÕES

Crie uma conta gratuita na Oracle Cloud, e provisione um cluster Kubernetes usando o Terraform de forma simples e rápida.

Oferta Especial #MêsDoKubernetes

Criando uma conta gratuita na Oracle Cloud

  1. Todos terão acesso a um tenant individual para execução do lab. Para ativar o ambiente, acesse este link e crie a sua conta.

IMPORTANTE:

  • No cadastro o País/Território será Brazil mas a Home Region do seu cadastro será "US East-Ashburn”.
  • Utilizem o mesmo e-mail que vocês usaram para se inscrever no evento, pois habilitamos uma oferta gratuita nesses e-mails. Caso já tenham uma conta OCI neste e-mail nos enviem um novo e-mail que habilitaremos outra oferta para vocês.
  • No cadastro não coloque o nome da empresa, pois ao colocar será necessário o CNPJ.
  • Se você já tiver um trial (acesso a nuvem da Oracle) ativo nesse email, você irá conseguir realizar o lab pois serão utilizados recursos always free, porém não terá os 500 dólares sem cartão pois um valor de testes já foi disponibilizado nos 30 dias da ativação.

Variáveis do Terraform personalizadas para o lab

Caso queira realizar o lab com as configurações utilizadas na live, basta substituir as variáveis do Terraform no arquivo variables.tf pelas variáveis abaixo. Mas lemre-se, as instâncias criadas com essas configurações só serão gratuitas enquanto os seus créditos oferecidos pela Oracle durante o #MêsDoKubernetes estiverem ativos.

region = us-ashburn-1

shape = VM.Standard.E3.Flex

memory_in_gbs_per_node = 2

image_id = ocid1.image.oc1.iad.aaaaaaaanwsto6tqklfuawgqrve5ugjpbff3l5qtb7bs35dp72ewcnsuwoka

node_size = 1

kubernetes_version = v1.28.2

Instalando o Terraform

- Linux

wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
sudo apt update && sudo apt install terraform

- Windows

  1. Baixe o Terraform e descompacte o arquivo em um diretório de sua preferência.

  2. Adicione o diretório ao PATH do Windows.

Baixando e configurando o OCI CLI

- Linux

  1. Execute o comando de instalação:
bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"

  1. Quando solicitado para atualizar a variável PATH, digite yes e ele atualizará automaticamente seu arquivo .bashrc ou .bash_profile para você. Se você usar um shell diferente, precisará informar o caminho para o OCI CLI (por exemplo, ~/zshrc).

  2. Reinicie sua sessão no terminal.

  3. Verifique a instalação.

oci -v

- Windows

  1. Faça download do instalador MSI da CLI do OCI para Windows no GitHub Releases

  2. Execute o instalador e siga as instruções.

Configurando o OCI CLI

  1. Execute o comando de configuração.
oci session authenticate --region us-ashburn-1
  1. Exporte o token de autenticação.
  • Linux
export OCI_CLI_AUTH=security_token
  • Windows
set OCI_CLI_AUTH=security_token
  1. Verifique se a configuração foi realizada com sucesso.
oci session validate --config-file ~/.oci/config --profile DEFAULT --auth security_token

Instalando seu Kubectl | Kubernetes 1.28.2 |

GNU/Linux

Kubectl é quem faz a comunicação com a API Kubernetes usando CLI. Devemos usar a mesma versão que está explicita na variáveis do terraform. Veja variables.tf

  1. Baixando o binário kubectl
curl -LO https://dl.k8s.io/release/v1.28.2/bin/linux/amd64/kubectl
  1. Instalando o binário
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
  1. Adicione kubectl completion bash
echo '
source <(kubectl completion bash)' >> ~/.bashrc
  1. Valide a versão
kubectl version --client
  • Note: O comando acima irá gerar um aviso: "WARNING: This version information is deprecated and will be replaced with the output from kubectl version --short."

Você pode ignorar este aviso. Você está apenas verificando a versão do kubectl que instalou.

Windows

  1. Baixe o binário kubectl
curl.exe -LO "https://dl.k8s.io/release/v1.28.2/bin/windows/amd64/kubectl.exe"

  1. Anexe a pasta binária kubectl à sua variável de ambiente PATH.

  2. Valide a versão

kubectl version --client --output=yaml

🔗 Guia de instalação para todos os ambientes

Criando o cluster

  1. Clone o repositório.
git clone https://github.com/Rapha-Borges/oke-free.git
  1. Dentro do diretório do projeto, gere a chave SSH e adicione o valor da chave pública na TF_VAR.
ssh-keygen -t rsa -b 4096 -f id_rsa
  • Linux
export TF_VAR_ssh_public_key=$(cat id_rsa.pub)
  • Windows
set /p TF_VAR_ssh_public_key=<id_rsa.pub
  1. Valide o tempo de vida do token de autenticação, aconselho que o tempo de vida seja maior que 30 minutos.
oci session validate --config-file ~/.oci/config --profile DEFAULT --auth security_token

Caso o token esteja próximo de expirar, faça o refresh do token e exporte novamente.

oci session refresh --config-file ~/.oci/config --profile DEFAULT --auth security_token
export OCI_CLI_AUTH=security_token
  1. Inicialize o Terraform.
terraform init
  1. Crie o cluster.
terraform apply
  • OBS: Opicionalmente, você pode utilizar o comando terraform plan para visualizar as alterações que serão realizadas antes de executar o terraform apply. Com os seguintes comandos:
terraform plan -out=oci.tfplan
terraform apply "oci.tfplan" -auto-approve
  1. Acesse o cluster.
kubectl get nodes

Script para criação do cluster

Caso queira automatizar o processo de criação do cluster, basta executar o script main.sh que está na raiz do projeto. O script irá gerar a chave SSH, adicionar a chave pública na TF_VAR, inicializar o Terraform e criar o cluster.

Atenção: O script está em fase de testes e funciona apenas no Linux.

./main.sh

Load Balancer

O cluster que criamos já conta com um Network Load Balancer configurado para expor uma aplicação na porta 80. Basta configurar um serviço do tipo NodePort com a porta 80 e a nodePort 30080. Exemplos de como configurar o serviço podem ser encontrados no diretório manifests.

O endereço do Load Balancer é informado na saída do Terraform, no formato public_ip = "xxx.xxx.xxx.xxx" e pode ser consultado a qualquer momento com o comando:

terraform output public_ip

Deletando o cluster

  1. Para deletar o cluster bastar executar o comando:
terraform destroy

Problemas conhecidos

  • Se você tentar criar um cluster com uma conta gratuita e receber o erro abaixo

Error: "Out of capacity" ou "Out of host capacity"

As contas gratuitas tem um número limitado de instâncias disponíveis, possivelmente a região que você está tentando criar o cluster não tem mais instâncias disponíveis. Você pode esperar até que novas instâncias fiquem disponíveis ou tentar criar o cluster em outra região. Além disso, o upgrade para uma conta Pay As You Go pode resolver o problema, pois as contas Pay As You Go tem um número maior de instâncias disponíveis. Você não será cobrado pelo uso de recursos gratuitos mesmo após o upgrade.

  • Erro 401-NotAuthenticated ou o comando kubectl não funciona. Isso ocorre porque o token de autenticação expirou

Gere um novo token de autenticação e exporte para a variável de ambiente OCI_CLI_AUTH.

oci session authenticate --region us-ashburn-1
  • Linux
export OCI_CLI_AUTH=security_token
  • Windows
set OCI_CLI_AUTH=security_token

  • Erros devido a falha na execução do terraform destroy, impossibilitando a exclusão do cluster e todos os recuros. Ou erros como o Error Code: CompartmentAlreadyExists que não são resolvidos com o terraform destroy

Para resolver esse problema, basta deletar os recursos manualmente no console da OCI. Seguindo a ordem abaixo:

Obs: Caso não apareça o Cluster ou a VPN para deletar, certifique que selecionou o Compartment certo k8s.

Autenticando com o uso da API KEY

Você pode utilizar a autenticação do tipo API KEY para criar e gerenciar o seu cluster. A vantage desse tipo de autenticação é que você não precisa utilizar o session token.

  1. Crie uma API key
  • Entre no seu perfil, acesse a aba API Keys e clique em Add API Key.

  1. Selecione Generate API key pair, faça o download da chave privada. Em seguida, clique em Add.

  2. Após o download, mova a chave para o diretório ~/.oci/ e renomeie para oci_api_key.pem.

mv ~/Downloads/<nome_do_arquivo>.pem ~/.oci/oci_api_key.pem
  1. Corrija as permissões da chave privada:
oci setup repair-file-permissions --file ~/.oci/oci_api_key.pem
  1. Copie o texto que apareceu na página de criação da API KEY para o arquivo ~/.oci/config. Não se esqueça de substituir o valor do compo key_file pelo caminho da chave privada ~/.oci/oci_api_key.pem, conforme exemplo abaixo.
vim ~/.oci/config

[DEFAULT]
user=ocid1.user.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
fingerprint=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tenancy=ocid1.tenancy.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
region=xxxxxxxx
key_file=~/.oci/oci_api_key.pem
  1. Adicione os valores ao arquivo export_variables.sh, para exportar todas as variáveis necessárias para a autenticação do terraform.
export TF_VAR_tenancy_ocid=<your tenancy ocid>
export TF_VAR_user_ocid=<your user ocid>
export TF_VAR_fingerprint=<your fingerprint>
export TF_VAR_private_key_path=~/.oci/oci_api_key.pem
export TF_VAR_ssh_public_key=$(cat id_rsa.pub)
export TF_VAR_ssh_private_key=$(cat id_rsa)

Agora rode o script para exportar as variáveis:

source export_variables.sh

Siga o passo abaixo somente após a criação do cluster com sucesso.

  1. Edite o arquivo ~/.kube/config seguindo o modelo abaixo:
- name: user-xxxxxxxxxx
  user:
    exec:
      apiVersion: client.authentication.k8s.io/v1beta1
      command: oci
      args:
      - ce
      - cluster
      - generate-token
      - --cluster-id
      - xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      - --region
      - xxxxxxxxxxx
      - --auth            # ADICIONE ESSA LINHA
      - api_key           # ADICIONE ESSA LINHA
      - --profile         # ADICIONE ESSA LINHA
      - DEFAULT           # ADICIONE ESSA LINHA

Referências