Utilizzare i file YAML di Google Cloud e Kubernetes in Cloud Code for IntelliJ

Cloud Code è progettato per facilitare la modifica dei file di configurazione relativi a Kubernetes, inclusi convalida basata su schema, diagnostica e documentazione rapida. Google Cloud

Nota: per motivi di compatibilità, le funzionalità di modifica di Kubernetes vengono disattivate automaticamente se viene rilevato il plug-in Kubernetes di JetBrains. Esegui manualmente l'override di questa impostazione nel menu delle impostazioni di Cloud Code andando a Cloud Code > Kubernetes > Funzionalità di modifica di Kubernetes e attivando/disattivando l'impostazione Abilita le funzionalità di modifica della configurazione YAML di Kubernetes. Queste misure di compatibilità interessano solo i file YAML di Kubernetes. Il supporto per altri tipi di file di configurazione YAML come Skaffold non è interessato.

Nota: il supporto per la modifica dei file YAML di Cloud Build è disponibile solo per i file denominati cloudbuild.yaml

File di configurazione YAML supportati

• Anthos Config Management
• Cloud Build
• Config Connector
• Knative
• Kubernetes
• Kustomize
• Migrate to Containers
• Skaffold

Cloud Code supporta anche i CRD di Kubernetes più diffusi, come Kubeflow, senza configurazione.

Nota: per utilizzare l'aggregazione delle risorse più aggiornata, devi avere l'ultima versione di Cloud Code.

Attivare o disattivare il supporto YAML

Per attivare o disattivare il supporto YAML, vai a File > Impostazioni > Strumenti > Gemini + Google Cloud Code > Kubernetes (per Windows e Linux) o IntelliJ IDEA > Impostazioni > Strumenti > Gemini + Google Cloud Code > Kubernetes (per macOS) e seleziona o deseleziona la casella di controllo Abilita il supporto YAML per attivare o disattivare la funzionalità.

Utilizzare uno schema personalizzato

Con Cloud Code, puoi fornire il tuo schema CRD con le impostazioni di IntelliJ andando a File > Impostazioni > Strumenti > Gemini + Google Cloud Code > Kubernetes (per Windows e Linux) o IntelliJ IDEA > Impostazioni > Strumenti > Gemini + Google Cloud Code > Kubernetes (per macOS) e poi facendo riferimento alla sezione Percorsi dello schema CRD.

Puoi fare riferimento a un file locale o a un URL. Gli URL che rimandano a github.com vengono convertiti automaticamente in raw.githubusercontent.com.

Estrarre lo schema da un cluster

Quando passi a un cluster che esegue Kubernetes v1.16+ in the Kubernetes Explorer, Cloud Code estrae automaticamente lo schema di tutti i CRD installati.

Supporto aggiuntivo per Skaffold

Skaffold è il motore sottostante che alimenta Cloud Code, aiutandoti a creare, eseguire il push e il deployment della tua applicazione oltre a fornire supporto per la creazione di pipeline CI/CD.

Cloud Code offre un supporto aggiuntivo per la gestione dei file di configurazione di Skaffold. Quando apri un progetto, Cloud Code rileva gli schemi Skaffold non aggiornati e ti chiede (tramite il log eventi) quando è disponibile un upgrade della versione dello schema Skaffold per i file di configurazione YAML di Skaffold esistenti.

In alternativa, puoi andare a Strumenti > Gemini + Cloud Code > Kubernetes > Verifica la disponibilità di upgrade degli schemi Skaffold per verificare la disponibilità di upgrade degli schemi.

Configurare con gli snippet

Gli snippet predefiniti per lo schema YAML comune (utilizza Ctrl+Spazio per visualizzare le opzioni) ti consentono di avviare un nuovo file YAML o di aggiungerne uno esistente senza errori, pur seguendo le best practice. Inoltre, è più facile lavorare con i campi ripetitivi: compila un campo e Cloud Code compila le istanze rimanenti.

Cloud Code offre i seguenti snippet:

• Cloud Build - Cloud Run deployment
• Cloud Build - Docker container build
• Cloud Build - GKE deployment
• Cloud Build - GKE Skaffold deployment
• Cloud Build - Go build
• Cloud Build - Terraform plan + apply
• Config Connector - BigQueryDataset
• Config Connector - BigQueryTable
• Config Connector - BigtableCluster
• Config Connector - BigtableInstance
• Config Connector - PubSubSubscription
• Config Connector - PubSubTopic
• Config Connector - RedisInstance
• Config Connector - SpannerInstance
• Kubernetes - ConfigMap
• Kubernetes - Deployment
• Kubernetes - Ingress
• Kubernetes - Pod
• Kubernetes - Service
• Migrate to Containers - Export
• Migrate to Containers - PersistentVolumeClaim
• Migrate to Containers - StatefulSet
• Skaffold - Bazel
• Skaffold - Getting-started
• Skaffold - Helm deployment
• Skaffold - Kaniko

Completare con il contesto

In base allo schema attuale, Cloud Code fornisce completamenti contestuali per aiutarti a scegliere l'opzione giusta.

Convalidare lo schema YAML

Cloud Code offre il supporto per la convalida dello schema contrassegnando tag e valori non validi nei file YAML e suggerendo correzioni, se possibile.

Convalidare i file YAML di Skaffold

Cloud Code fornisce un supporto aggiuntivo per la modifica dei file di configurazione di Skaffold e modelli intelligenti che consentono di convalidare i file skaffold.yaml. Consulta questa guida sull'utilizzo di un'app esistente con Cloud Code.

Completare i file di configurazione di Skaffold con il contesto

In base allo schema attuale, Cloud Code fornisce completamenti contestuali e documentazione pertinente per aiutarti a scegliere l'opzione giusta.

Scoprire le definizioni utilizzando la documentazione rapida

Cloud Code mostra la documentazione pertinente per una risorsa quando evidenzi una riga nel file di configurazione e vai a Visualizza > Documentazione rapida.

Eseguire l'analisi tramite lint di YAML per problemi strutturali e di validità

Cloud Code fornisce il supporto per l'analisi tramite lint per i problemi di schema comuni e fornisce errori descrittivi.

Applicare un file YAML

Per eseguire kubectl apply -f per applicare una modifica alla configurazione utilizzando il file corrente, puoi utilizzare l'icona delle azioni kubectl , disponibile nel margine dell'IDE, e selezionare Applica. Viene visualizzata una visualizzazione differenze per esaminare le modifiche prima di fare clic su Applica.

Visualizzare le differenze tra i file YAML

Per visualizzare le differenze tra un file YAML nel controllo del codice sorgente e un file YAML di cui è stato eseguito il deployment, puoi utilizzare l'icona delle azioni kubectl disponibile nel margine dell'editor. Seleziona l'opzione Differenze per visualizzare una visualizzazione differenze per confrontare due file di schema.

Eseguire un'esecuzione di prova di un file YAML

Per eseguire un dry run del file e verificarne la validità, puoi utilizzare l' icona delle azioni kubectl , disponibile nel margine dell'IDE, per selezionare Dry-run on Server o Dry-run on Client. Viene eseguito kubectl apply -f dry-run=server (o kubectl apply -f dry-run=client, per l'opzione Client) e ti viene comunicato se il file può essere creato correttamente nella finestra del terminale.

Passaggi successivi

• Crea un file skaffold.yaml di configurazione di esecuzione Cloud Code Kubernetes.
• Crea manualmente una configurazione Skaffold per la tua applicazione.
• Visualizza la documentazione di riferimento Skaffold.yaml.

Assistenza

Per inviare feedback o segnalare un problema nell'IDE IntelliJ, vai a Strumenti > Cloud Code > Guida / Informazioni > Invia feedback o segnala un problema per segnalare un problema su GitHub.