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

Cloud Code è progettato per aiutarti a modificare i file di configurazione relativi a Google Cloud e Kubernetes, inclusa la convalida basata su schema, la diagnostica e la documentazione rapida.

Nota: per motivi di compatibilità, le funzionalità di modifica di Kubernetes vengono disabilitate automaticamente se viene rilevato il plug-in Kubernetes di JetBrains. Sostituisci manualmente 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à riguardano solo i file YAML di Kubernetes. Il supporto di 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 nominati 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 Kubernetes più diffusi, come Kubeflow, out-of-the-box.

Nota: per utilizzare l'aggregazione delle risorse più aggiornata, devi disporre della versione più recente di Cloud Code.

Attivare o disattivare il supporto YAML

Per attivare o disattivare il supporto di 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 Attiva il supporto di YAML per attivare o disattivare la funzionalità.

Utilizza schema personalizzato

Con Cloud Code, puoi fornire il tuo schema CRD con le impostazioni di IntelliJ > 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 fai riferimento alla sezione Località 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.

Esegui il pull dello schema da un cluster

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

Supporto aggiuntivo di Skaffold

Skaffold è il motore sottostante che alimenta Cloud Code, aiutandoti a creare, eseguire push e implementare la tua applicazione, nonché a fornire assistenza per la creazione di pipeline CI/CD.

Cloud Code offre un'assistenza aggiuntiva 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) se è disponibile un upgrade della versione dello schema Skaffold per i file di configurazione YAML Skaffold esistenti.

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

Configurare con gli snippet

Gli snippet pronti all'uso per lo schema YAML comune (utilizzando Ctrl+Spazio per visualizzare le opzioni) ti consentono di avviare un nuovo file YAML o di aggiungerne uno esistente senza errori, rispettando al contempo le best practice. Inoltre, è più facile lavorare con i campi ripetitivi: compilane uno 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 corrente, Cloud Code fornisce completamenti contestuali per aiutarti a scegliere l'opzione giusta.

Convalida lo schema YAML

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

Convalida i file YAML di Skaffold

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

Completare i file di configurazione di Skaffold con il contesto

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

Scopri 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.

Esegui lint del file YAML per rilevare problemi di struttura e validità

Cloud Code fornisce il supporto di linting per i problemi comuni dello schema e fornisce errori descrittivi.

Applica 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 nell'area di guardia dell'IDE, e selezionare Applica. Viene visualizzata una visualizzazione della differenza per consentirti di esaminare le modifiche prima di fare clic su Applica.

Differenza 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 nell'area di guardia dell'editor. Seleziona l'opzione Differenza per visualizzare una visualizzazione delle differenze che ti consente di confrontare e mettere a confronto due file dello schema.

Esegui una prova di un file YAML

Per eseguire una simulazione del file e verificarne la validità, puoi utilizzare l'icona delle azioni kubectl, disponibile nella canalina dell'IDE, per selezionare Simulazione sul server o Simulazione sul client. Viene eseguito kubectl apply -f dry-run=server (o kubectl apply -f dry-run=client per l'opzione Client) e ti viene inviata una notifica se il file può essere creato correttamente nella finestra del terminale.

Passaggi successivi

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

Assistenza

Per inviare un 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.