Este documento ha sido traducido utilizando tecnología de traducción automática. Si bien nos esforzamos por proporcionar traducciones precisas, no ofrecemos garantías sobre la integridad, precisión o confiabilidad del contenido traducido. En caso de discrepancia, la versión original en inglés prevalecerá y constituirá el texto autorizado.

Guía de inicio rápido de RK-API

Puedes acceder a los recursos de Rancher a través de la API de Kubernetes. Esta guía te ayuda a comenzar a utilizar esta API como usuario de Rancher.

  1. En la esquina superior izquierda, haz clic en ☰ > Configuración Global.

  2. Encuentra y copia la dirección en el campo server-url.

  3. rancher-admin/users/settings/api-keys.adoc#_creando_una_clave_api[Crear] una clave API de Rancher sin alcance.

Una clave API de Rancher sin alcance otorga acceso irrestricto a todos los recursos a los que el usuario puede acceder. Para prevenir el uso no autorizado, esta clave debe almacenarse de forma segura y rotarse con frecuencia.

  1. Crea un archivo kubeconfig.yaml. Reemplaza $SERVER_URL con la URL del servidor y $API_KEY con tu clave API de Rancher:

     apiVersion: v1
 kind: Config
 clusters:
 - name: "rancher"
   cluster:
     server: "$SERVER_URL"

 users:
 - name: "rancher"
   user:
     token: "$API_KEY"

 contexts:
 - name: "rancher"
   context:
     user: "rancher"
     cluster: "rancher"

 current-context: "rancher"

Puedes usar este archivo con cualquier herramienta compatible, como kubectl o client-go. Para una demostración rápida, consulta el ejemplo de kubectl.

Para más información sobre cómo manejar configuraciones de certificados más complejas, consulta Especificando Certificados CA.

Para más información sobre las opciones de kubeconfig disponibles, consulta la documentación upstream.

Ejemplo de API kubectl

En este ejemplo, mostraremos cómo usar kubectl para crear un proyecto, seguido de su eliminación. Para una lista de otros recursos de Rancher disponibles, consulta la página Referencia de API.

En este momento, no todos los recursos de Rancher están disponibles a través de la API de Kubernetes de Rancher.

  1. Establece tu variable de entorno KUBECONFIG al archivo kubeconfig que acabas de crear:

  export KUBECONFIG=$(pwd)/kubeconfig.yaml

  1. Usa kubectl explain para ver los campos disponibles para proyectos, o subcampos complejos de recursos:

  kubectl explain projects
  kubectl explain projects.spec

No todos los recursos pueden tener una salida detallada.

  1. Añade el siguiente contenido a un archivo llamado project.yaml:

  apiVersion: management.cattle.io/v3
  kind: Project
  metadata:
    # name should be unique across all projects in every cluster
    name: p-abc123
    # generateName can be used instead of `name` to randomly generate a name.
    # generateName: p-
    # namespace should match spec.ClusterName.
    namespace: local
  spec:
    # clusterName should match `metadata.Name` of the target cluster.
    clusterName: local
    description: Example Project
    # displayName is the human-readable name and is visible from the UI.
    displayName: Example

  1. Crear el proyecto:

  kubectl create -f project.yaml

  1. Eliminar el proyecto:

Cómo eliminas el proyecto depende de cómo creaste el nombre del proyecto.

A. Si utilizaste name al crear el proyecto:

```bash
kubectl delete -f project.yaml
```

B. Si utilizaste generateName:

Replace `$PROJECT_NAME` with the randomly generated name of the project displayed by Kubectl after you created the project.

```bash
kubectl delete project $PROJECT_NAME -n local
```

Especificando Certificados CA

Para asegurar que tus herramientas puedan reconocer los certificados CA de Rancher, la mayoría de las configuraciones requieren modificaciones adicionales a la plantilla anterior.

  1. En la esquina superior izquierda, haz clic en ☰ > Configuración Global.

  2. Encuentra y copia el valor en el campo ca-certs.

  3. Guarda el valor en un archivo llamado rancher.crt.

Si tu instancia de Rancher está detrás de un proxy u otro servicio, debes extraer el certificado que dicho servicio está utilizando y añadirlo al archivo kubeconfig, como se demuestra en el paso 5.

  1. Los siguientes comandos convierten rancher.crt a salida en base64, eliminan todas las nuevas líneas y actualizan el clúster en el kubeconfig con el certificado, y luego terminan eliminando el archivo rancher.crt:

  export KUBECONFIG=$PATH_TO_RANCHER_KUBECONFIG
  kubectl config set clusters.rancher.certificate-authority-data $(cat rancher.crt | base64 -i - | tr -d '\n')
  rm rancher.crt

  1. (Opcional) Si utilizas certificados autofirmados que no son de confianza para tu sistema, puedes establecer la opción insegura en tu kubeconfig con kubectl:

Esta opción no debería usarse en producción ya que es un riesgo de seguridad.

 
  export KUBECONFIG=$PATH_TO_RANCHER_KUBECONFIG
  kubectl config set clusters.rancher.insecure-skip-tls-verify true

Si tu instancia de Rancher está detrás de un proxy u otro servicio, debes extraer el certificado que dicho servicio está utilizando y añadirlo al archivo kubeconfig, como se demostró arriba.