O Controle de agentes do New Relic com o Terraform fornece uma solução poderosa e declarativa para gerenciar frotas de agentes em escala. Ao usar o Terraform e o Controle de agentes em conjunto, é possível garantir uma abordagem consistente, repetível e escalável para implantar a instrumentação do New Relic em toda a infraestrutura, especialmente ao lidar com vários clusters do Kubernetes.
Pré-requisitos
Antes de começar, certifique-se de ter o seguinte:
Ferramentas necessárias:
- Terraform instalado na sua máquina.
- Helm 3 instalado na sua máquina. Para obter instruções de instalação, consulte Instalando o Helm.
- O Terraform Helm Provider está incluído no seu script de configuração do Terraform para que a instalação funcione.
Credenciais da New Relic:
- Chave de licença New Relic : Você precisará de uma chave de licença New Relic para reportar telemetria para sua conta New Relic .
- Chave de usuário do New Relic: você precisará da sua chave de usuário do New Relic caso ainda não tenha obtido sua chave e segredo
clientID.
Detalhes da configuração:
- ID da organização New Relic : O New Relic
OrgIdidentificará de qual organização você está obtendo sua chave de ID de cliente e segredo. - Permissões de usuário: seu usuário precisa das permissões corretas para criar uma identidade do sistema. Isso normalmente requer a função de Gerenciador de domínio de autenticação ou New Relic Control.
- Nome do cluster do Kubernetes: tenha o nome do seu cluster do Kubernetes pronto, pois ele será referenciado durante o processo de instalação.
- ID da organização New Relic : O New Relic
Dica
Ao configurar um novo cluster com o Terraform, certifique-se de usar o mesmo nome de cluster durante a instalação do Controle de agentes.
Compatibilidade com Kubernetes
Para descobrir quais versões do Kubernetes são compatíveis com esta solução, consulte a seção de compatibilidade na visão geral.
Instalar
Se você não tiver clientId e clientSecret, use a seguinte chamada de API do NerdGraph para gerá-los. Isso requer sua chave de usuário administrador e ID de organização New Relic .
$curl -X POST \> https://api.newrelic.com/graphql \> -H 'Content-Type: application/json' \> -H 'x-api-key: [INSERT_USER_API_KEY]' \> --data-raw '{"query": "mutation SICreate { systemIdentityCreate(name: \"User Key for Agent Control\" organizationId: \"[INSERT_YOUR_ORG_ID]\") { clientId clientSecret } }"}' \> --compressedNo comando, substitua os valores do espaço reservado pelo seu organizationId e pela chave do usuário. Isso retorna as credenciais necessárias que você usará no seu arquivo de configuração.
Etapa 1: Crie seu diretório de projeto
Crie um diretório para seu projeto e coloque seu arquivo main.tf dentro dele. É aqui que você definirá seus recursos do Terraform. Confirme se você adicionou o provedor Helm ao seu arquivo Terraform.
Etapa 2: Configurar o Terraform com o Helm Release
Configure seu script Terraform com uma versão Helm que usa os gráficos do New Relic para controle do agente. O exemplo a seguir mostra uma configuração básica:
provider "helm" { kubernetes { config_paths = [ "~/.kube/config" ] }}
resource "helm_release" "newrelic" { name = "agent-control" repository = "https://newrelic.github.io/helm-charts/" chart = "agent-control" namespace = "newrelic" create_namespace = "true"
values = [ file("./values-newrelic.yaml") ]}Observe que o script do Terraform faz referência a um arquivo values-newrelic.yaml . Este é o arquivo de configuração do Agent Control New Relic que será usado para configurar o Agent Control. Não precisa estar no mesmo diretório que o script do Terraform. Você pode referenciá-lo de qualquer local fornecendo o caminho correto na função file() dentro do atributo values do recurso helm_release .
Ou, se você colocar o arquivo values-newrelic.yaml diretamente no diretório do projeto Terraform, o script main.tf fará referência a ele automaticamente.
Aqui está um exemplo de um arquivo values-newrelic.yaml básico sem nenhuma configuração adicional incluída:
global: cluster: [YOUR_CLUSTER_NAME] licenseKey: [YOUR_INGEST_LICENSE_KEY]
agentControlDeployment: chartValues: systemIdentity: organizationId: [ORG_ID] parentIdentity: clientId: [YOUR_IDENTITY_CLIENT_ID] clientSecret: [YOUR_IDENTITY_CLIENT_SECRET] config: fleet_control: # optional fleet_id: [YOUR_FLEET_ENTITY_GUID] log: level: tracePara explorar todas as configurações disponíveis, consulte values-newrelic.yaml.
Etapa 3: executar comandos do Terraform
Inicialize o Terraform, revise o plano e aplique as alterações.
$# Initialize Terraform$terraform init$# Review the changes before applying$terraform plan$# Apply the changes to your cluster$terraform applyEtapa 5: Verifique a instalação
Verifique se o pod de controle do agente e qualquer agente configurado estão sendo executados corretamente em seus respectivos namespaces.
$# Check Agent Control pods$kubectl get pods -n newrelic$# Check pods in the agent namespace, e.g., 'newrelic-agents'$kubectl get pods -n newrelic-agentsConfiguração
No arquivo values-newrelic.yaml você pode configurar o agente Control para implantar múltiplos agentes de monitoramento. Aqui está um exemplo mostrando a implantação de vários agentes, incluindo:
- Infrastructure: agente de infraestrutura da New Relic
- Logs: Agente de logs de Fluent Bit
- OpenTelemetry: A distribuição New Relic do OpenTelemetry Collector
- Gateway: Agente de gateway de controle de Pipeline de New Relic
agentControlDeployment: chartValues: systemIdentity: organizationId: "****" parentIdentity: clientId: [YOUR_IDENTITY_CLIENT_ID] clientSecret: [YOUR_IDENTITY_CLIENT_SECRET] config: agents: infrastructure: agent_type: newrelic/com.newrelic.infrastructure:0.1.0 logs: agent_type: newrelic/io.fluentbit:0.1.0 agent-operator: agent_type: com.newrelic.k8s_agent_operator:0.1.0 open-telemetry: agent_type: newrelic/com.newrelic.opentelemetry.collector:0.1.0 gateway: agent_type: newrelic/com.newrelic.pipeline_control_gateway:0.1.0 agentsConfig: infrastructure: chart_version: "*" chart_values: newrelic-infrastructure: enableProcessMetrics: true logs: # Ref: `https://github.com/newrelic/helm-charts/tree/master/charts/newrelic-logging` # Recommended: check and define an explicit chart version (latest stable) chart_version: "*" chart_values: newrelic-logging: sendMetrics: true agent-operator: chart_version: "*" open-telemetry: # Ref: `https://github.com/newrelic/helm-charts/blob/master/charts/nr-k8s-otel-collector/values.yaml` # Recommended: check and define an explicit chart version (latest stable) chart_version: "*" chart_values: nr-k8s-otel-collector: receivers.filelog.enabled: false gateway: chart_version: "*" chart_values: gateway: autoscaling: minReplicas: 2 maxReplicas: 10 targetCPUUtilizationPercentage: 70Importante
Importante: Para ambiente de produção, recomendamos fortemente usar um chart_version específico e fixado em vez de um curinga (*). Isso garante atualizações consistentes e previsíveis, evitando comportamentos inesperados ou alterações significativas.
Desinstalar
Importante
Remover um recurso de versão do Helm da sua configuração do Terraform é uma ação destrutiva. Ao executar terraform apply após essa alteração, o Terraform desinstalará o gráfico e destruirá todos os recursos relacionados, o que pode levar à perda de dados. Antes de prosseguir, certifique-se de entender completamente o impacto potencial no seu ambiente:
- Revise todas as dependências e serviços que podem ser afetados.
- Considere fazer backup de quaisquer dados persistentes ou configurações vinculadas à versão.
- Confirme se a remoção desta versão é necessária e se ajusta à sua estratégia de gerenciamento de infraestrutura. Sempre tenha cuidado ao fazer alterações significativas em sua infraestrutura e garanta que você tenha procedimentos de reversão adequados em vigor caso algo dê errado.
Para desinstalar o agente Control:
- Remova o bloco de recursos
helm_releaseparanewrelic_agent_controldo seu arquivomain.tf. - Execute
terraform planpara revisar as alterações. Examine cuidadosamente a saída do plano para garantir que apenas os recursos pretendidos sejam marcados para exclusão. - Execute
terraform applye confirme a execução para desinstalar a versão. Isso implementará as alterações planejadas, removendo efetivamente a versão especificada do Helm do seu ambiente.
Confirme a execução quando solicitado para concluir o processo de desinstalação.