{"id":12898,"date":"2022-03-16T11:24:50","date_gmt":"2022-03-16T18:24:50","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=12898"},"modified":"2025-06-13T21:25:04","modified_gmt":"2025-06-14T04:25:04","slug":"capella-clusters-as-code-deploying-couchbase-via-api","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/capella-clusters-as-code-deploying-couchbase-via-api\/","title":{"rendered":"Capella Clusters as Code - Implementa\u00e7\u00e3o do Couchbase via API"},"content":{"rendered":"

Com <\/span>Couchbase Capella<\/span><\/a>Com o nosso DBaaS totalmente hospedado, voc\u00ea pode provisionar um cluster inteiro do Couchbase em minutos. Sem precisar saber nada sobre a implanta\u00e7\u00e3o do Couchbase, voc\u00ea pode ter toda a infraestrutura provisionada, configurada, protegida e, finalmente, pronta para uso, tudo isso sem precisar ter conhecimentos espec\u00edficos nessas \u00e1reas - isso \u00e9 revolucion\u00e1rio! Anteriormente, esses tipos de tarefas de gerenciamento eram realizados por equipes de projeto e o sucesso era medido em semanas, mas agora tudo isso pode ser realizado por meio de uma GUI em minutos.<\/span><\/p>\n

No entanto, n\u00e3o paramos de criar apenas uma GUI f\u00e1cil de usar. Tamb\u00e9m lan\u00e7amos uma API que pode ser usada para provisionar clusters, para muitas finalidades diferentes. Por mais que as GUIs sejam \u00f3timas, n\u00e3o h\u00e1 nada melhor do que ter um script executado em segundo plano enquanto voc\u00ea continua seu dia ou l\u00ea o xkcd.\u00a0<\/span><\/p>\n

Falando s\u00e9rio, automatizar o provisionamento de clusters economiza muito tempo, tanto em ambientes de cluster transit\u00f3rios quanto em casos de uso em que v\u00e1rios clusters precisam ser criados, por exemplo, replica\u00e7\u00e3o geodistribu\u00edda. A chave aqui tamb\u00e9m \u00e9 ajudar a diminuir o trabalho, <\/span>de acordo com o manual do SRE<\/span><\/a>e isso pode ser apenas a ponta do iceberg.\u00a0<\/span><\/p>\n

Ap\u00f3s o provisionamento automatizado, voc\u00ea pode come\u00e7ar a <\/span>configurar clusters por meio de APIs<\/b> bem como <\/span>processos com script<\/b>. Um dos principais princ\u00edpios da Capella \u00e9 automatizar e utilizar o conhecimento especializado do Couchbase, para que voc\u00ea possa se concentrar no fornecimento e no cumprimento dos principais objetivos comerciais - em termos de vendas, proporcionando vantagem competitiva \u00e0s empresas.\u00a0<\/span><\/p>\n

Para lhe dar um gostinho da redu\u00e7\u00e3o do trabalho e uma ideia de como seria passar o tempo trabalhando em seus problemas de neg\u00f3cios, e n\u00e3o em seu banco de dados, criei um script Python que fornecer\u00e1 um cluster por meio de nossa API, sem nenhuma intera\u00e7\u00e3o com a GUI. O script usa os auxiliares de API criados por Jon Giffard (gerente principal de produtos da Capella) e criar\u00e1 um cluster com base em uma configura\u00e7\u00e3o personaliz\u00e1vel.<\/span><\/p>\n

Configura\u00e7\u00e3o de chaves Python e API<\/span><\/h2>\n

Dentro de <\/span>este reposit\u00f3rio<\/span><\/a>, existe um <\/span>LEIAME<\/span><\/a> que explica os pr\u00e9-requisitos e como instalar as bibliotecas Python necess\u00e1rias que est\u00e3o listadas em <\/span>requisitos.txt<\/span><\/i>. Desde que seu sistema atenda aos pr\u00e9-requisitos e voc\u00ea tenha instalado os requisitos, <\/span>use a documenta\u00e7\u00e3o a seguir para gerar chaves de API<\/span><\/a> para seu locat\u00e1rio Capella (o <\/span>Propriet\u00e1rio da organiza\u00e7\u00e3o<\/span><\/i> \u00e9 necess\u00e1ria para gerar essas chaves).<\/span><\/p>\n

Pegue as chaves que voc\u00ea gerou, exporte as chaves da API como vari\u00e1veis ou crie um <\/span>EnvVars<\/span>.py<\/span><\/em> dentro do arquivo capellaAPI<\/em> conforme descrito na pasta <\/span>LEIAME<\/span><\/a>. Voc\u00ea pode testar se essas etapas foram bem-sucedidas executando: <\/span><\/p>\n

python3 getClouds.py<\/pre>\n
Se voc\u00ea obtiver uma sa\u00edda semelhante \u00e0 seguinte ao executar o comando <\/span>getClouds.<\/span><\/em>py<\/em> <\/span>voc\u00ea configurou seu ambiente com sucesso:<\/span><\/p>\n
\"Couchbase<\/a><\/p>\n
Automatiza\u00e7\u00e3o do script de provisionamento<\/span><\/h2>\n
Com seu ambiente configurado, \u00e9 hora de testar nosso script de automa\u00e7\u00e3o. No arquivo python<\/em> do reposit\u00f3rio ser\u00e1 a pasta <\/span>automa\u00e7\u00e3o<\/span>.py<\/span><\/em> file. Esse arquivo recebe apenas dois argumentos: um <\/span>projeto <\/span><\/i>nome e um <\/span>agrupamento <\/span><\/i>nome - o projeto deve ter sido criado antes da execu\u00e7\u00e3o do script.\u00a0<\/span><\/p>\n
Embora isso seja automatizado at\u00e9 certo ponto, ser\u00e1 necess\u00e1ria alguma configura\u00e7\u00e3o inicial. Depois de criar o projeto, voc\u00ea poder\u00e1 criar seus clusters usando o <\/span>automa\u00e7\u00e3o<\/span>.py<\/span><\/em> roteiro.\u00a0<\/span><\/p>\n
Por exemplo, se eu j\u00e1 tiver criado um projeto em meu locat\u00e1rio do Capella chamado <\/span>sam-demo<\/span><\/i> Ent\u00e3o, posso criar um cluster nesse projeto com um nome de <\/span>otto<\/span><\/i> assim:\u00a0<\/span><\/p>\n
python3 automation.py -pn \"sam-demo\" -cn \"otto-cluster\"<\/pre>\n
E o resultado final deve ser o seguinte (redigido para fins de brevidade):<\/span><\/p>\n
samredman@LEM0210 python % python3 automation.py -pn \"sam-demo\" -cn \"otto-cluster\"\r\n2022-03-15 19:02:04,142 - capellaAPI.CapellaAPI - INFO - \/v2\/status\r\n2022-03-15 19:02:04,784 - capellaAPI.CapellaAPI - INFO - \/v2\/projects?perPage=100\r\n2022-03-15 19:02:04,954 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\r\n2022-03-15 19:02:06,659 - capellaAPI.CapellaAPI - INFO - \/v2\/status\r\n2022-03-15 19:02:06,957 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\/a0e04426-a6cb-4bd9-8bb8-c9232b22b23d\/status\r\n2022-03-15 19:02:12,096 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\/a0e04426-a6cb-4bd9-8bb8-c9232b22b23d\/status\r\n2022-03-15 19:02:17,251 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\/a0e04426-a6cb-4bd9-8bb8-c9232b22b23d\/status\r\n2022-03-15 19:02:22,419 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\/a0e04426-a6cb-4bd9-8bb8-c9232b22b23d\/status\r\n2022-03-15 19:02:27,580 - capellaAPI.CapellaAPI - INFO - \/v3\/clusters\/a0e04426-a6cb-4bd9-8bb8-c9232b22b23d\/status\r\nStatus atual do cluster: em implementa\u00e7\u00e3o\r\nVerifique a API do Capella, agora criado o cluster otto-cluster<\/pre>\n
Removi algumas das verifica\u00e7\u00f5es repetidas; devemos receber uma atualiza\u00e7\u00e3o a cada 5 segundos - fique \u00e0 vontade para editar o intervalo de acordo com suas necessidades. Esse \u00e9 provavelmente um intervalo adequado, pois pode levar alguns minutos para criar um cluster. Verificar com mais frequ\u00eancia n\u00e3o acrescentaria mais informa\u00e7\u00f5es, mas qualquer coisa mais lenta pode parecer muito lenta.<\/span><\/p>\n
Ent\u00e3o, o que exatamente implantamos? <\/span><\/p>\n
Forneci uma configura\u00e7\u00e3o padr\u00e3o que atende aos requisitos de especifica\u00e7\u00e3o da API Capella. Vamos dar uma olhada nela na se\u00e7\u00e3o <\/span>createHostedClusterInProject.py<\/span><\/i> no arquivo p<\/em><\/span>ython<\/span><\/i> pasta:<\/span><\/p>\n
cluster_configuration = {\r\n    \"environment\" (ambiente): \"hospedado\",\r\n    \"clusterName\": nome do cluster,\r\n    \"description\" (descri\u00e7\u00e3o): \"Exemplo de cria\u00e7\u00e3o de cluster hospedado a partir da API p\u00fablica\",\r\n    \"projectId\": project_id,\r\n    \"place\": {\r\n        \"singleAZ\": True,\r\n        \"hosted\": {\r\n            \"provider\" (provedor): \"aws\",\r\n            \"CIDR\": \"10.199.0.0\/20\",\r\n            \"region\" (regi\u00e3o): \"eu-west-2\"\r\n        }\r\n    },\r\n    \"servers\": [\r\n        {\r\n            \"compute\": \"m5.large\",\r\n            \"size\": 3,\r\n            \"services\" (servi\u00e7os): [\"data\" (dados), \"index\" (\u00edndice), \"search\" (pesquisa), \"query\" (consulta)],\r\n            \"storage\" (armazenamento): {\r\n                \"size\": 50,\r\n                \"IOPS\": 3000,\r\n                \"type\" (tipo): \"GP3\"\r\n                },\r\n        }\r\n    ],\r\n    \"supportPackage\": {\r\n        \"timezone\": \"GMT\",\r\n        \"type\": \"Basic\"\r\n    },\r\n    \"version\" (vers\u00e3o): \"latest\",\r\n}<\/pre>\n
 <\/p>\n
E agora?<\/span><\/span><\/p>\n
Essa foi apenas uma configura\u00e7\u00e3o de teste de amostra, mas voc\u00ea pode ver que temos a especifica\u00e7\u00e3o m\u00ednima para: tamanho do n\u00f3 (3), um \u00fanico AZ e todos os servi\u00e7os. Ela n\u00e3o atende \u00e0s pr\u00e1ticas recomendadas, mas voc\u00ea poderia iniciar um cluster para testar o c\u00f3digo.<\/span><\/p>\n
Podemos conectar nosso aplicativo a esse cluster sem precisar passar pela GUI de configura\u00e7\u00e3o. Tudo o que voc\u00ea precisa fazer \u00e9 ajustar a configura\u00e7\u00e3o para usar seu <\/span>usu\u00e1rios do banco de dados<\/span><\/a>, <\/span>colocar seu IP na lista de permiss\u00f5es<\/span><\/a> e conecte seu aplicativo.<\/span><\/p>\n
Espero que isso desperte o interesse e a consci\u00eancia da arte do poss\u00edvel com nossa API. No futuro, adicionaremos mais funcionalidades \u00e0 API. Quando o fizermos, compartilharei um exemplo de execu\u00e7\u00e3o de alguns testes de regress\u00e3o em um cluster do Couchbase Capella provisionado automaticamente.<\/span><\/p>\n
Aqui est\u00e3o alguns dos recursos mencionados nesta postagem:<\/span><\/p>\n