CLI de Azure Service Fabric
La interfaz de línea de comandos (CLI) de Azure Service Fabric es una utilidad de línea de comandos para interactuar y administrar entidades de Service Fabric. La CLI de Service Fabric puede utilizarse con clústeres Windows o Linux. La CLI de Service Fabric se ejecuta en cualquier plataforma que sea compatible con Python.
Importante
Hay dos utilidades de la CLI que interactúan con Service Fabric. La CLI de Azure se utiliza para administrar los recursos de Azure, como un clúster de Service Fabric hospedado en Azure. La CLI de Service Fabric se utiliza para conectarse directamente al clúster de Service Fabric (independientemente de dónde esté hospedado) y administrar el clúster, las aplicaciones y los servicios.
Prerrequisitos
Antes de la instalación, asegúrese de que el entorno tiene Python y pip instalados. Para más información, consulte la documentación de inicio rápido de pip y la documentación oficial de instalación de Python.
La CLI es compatible con Python 2.7, 3.6 y versiones posteriores, pero se recomienda usar la 3.x.
Runtime de destino de Service Fabric
La CLI de Service Fabric debería ser compatible con la versión más reciente del runtime del SDK de Service Fabric. Use la siguiente tabla para determinar qué versión de la CLI debe instalar:
| Versión de la CLI | versión compatible del runtime |
|---|---|
| Más reciente (~=10) | Más reciente (~=7.1) |
| 9.0.0 | 7.1 |
| 8.0.0 | 6.5 |
| 7.1.0 | 6.4 |
| 6.0.0 | 6.3 |
| 5.0.0 | 6.2 |
| 4.0.0 | 6.1 |
| 3.0.0 | 6.0 |
| 1.1.0 | 5.6, 5.7 |
También puede especificar la versión de destino de la CLI que se va a instalar. Para ello debe usar ==<version> delante del comando pip install. Por ejemplo, en el caso de la versión 1.1.0 la sintaxis sería:
pip install -I sfctl==1.1.0
Reemplace el siguiente comando pip install por el comando mencionado anteriormente cuando sea necesario.
Para más información sobre las versiones de la CLI de Service Fabric, consulte la documentación de GitHub.
Instalación de pip, Python y la CLI de Service Fabric
Hay muchas maneras de instalar pip y Python en la plataforma. Estos son algunos pasos para configurar rápidamente los principales sistemas operativos con Python 3 y pip.
Windows
Para Windows 10, Windows Server 2016 y Windows Server 2012 R2, siga las instrucciones oficiales de la instalación estándar. El programa de instalación de Python también instala pip de forma predeterminada.
Vaya a la página de descargas de Python oficial y descargue la versión más reciente de Python 3.x.
Inicie el programa de instalación.
En la parte inferior de la interfaz, seleccione Agregar Python 3.x a PATH.
Seleccione Instalar ahora para finalizar la instalación.
Ahora puede abrir una nueva ventana de comandos y obtener la versión de Python y pip.
python --version
pip --version
Después, ejecute el siguiente comando para instalar la CLI de Azure Service Fabric (sfctl) y ver la página de ayuda de la CLI:
pip install sfctl
sfctl -h
Ubuntu y subsistema de Windows para Linux
Para ejecutar la CLI de Service Fabric, ejecute los siguientes comandos:
sudo apt-get install python3
sudo apt-get install python3-pip
pip3 install sfctl
A continuación, puede probar la instalación con:
sfctl -h
Si recibe un error del tipo command not found, como:
sfctl: command not found
Asegúrese de que se puede acceder a ~/.local/bin desde $PATH:
export PATH=$PATH:~/.local/bin
echo "export PATH=$PATH:~/.local/bin" >> .shellrc
Si se produce un error en la instalación en el subsistema de Windows para Linux debido a que los permisos de carpeta no son correctos, es posible que sea necesario volver a intentarlo con permisos superiores:
sudo pip3 install sfctl
Red Hat Enterprise Linux 7.4 (compatibilidad con la versión preliminar de Service Fabric)
Para instalar la CLI de Service Fabric en Red Hat, ejecute los siguientes comandos:
sudo yum install -y python38
sudo yum install python38-setuptools
sudo easy_install-3.4 pip
sudo pip3 install sfctl
Para probar la instalación, puede consultar los pasos mencionados en la sección Ubuntu y subsistema de Windows para Linux.
MacOS
Para MacOS, se recomienda utilizar el administrador de paquetes de HomeBrew. Si HomeBrew si no está ya instalado, puede hacerlo ejecutando el comando siguiente:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
A continuación, desde el terminal, ejecute los siguientes comandos para instalar Python 3.x, pip y la CLI de Service Fabric:
brew install python3
pip3 install sfctl
sfctl -h
Sintaxis de la CLI
Los comandos siempre tienen el prefijo sfctl. Para obtener información general acerca de todos los comandos que puede usar, use sfctl -h. Para obtener ayuda con un único comando, use sfctl <command> -h.
Los comandos siguen una estructura repetible, con el destino del comando precediendo al verbo o la acción.
sfctl <object> <action>
En este ejemplo, <object> es el destino de <action>.
Selección de un clúster
Para poder realizar cualquier operación, es preciso seleccionar un clúster al que conectarse. Por ejemplo, ejecute el siguiente comando para seleccionar y conectarse al clúster con el nombre testcluster.com:
Advertencia
No utilice clústeres de Service Fabric que no sean seguros en entornos de producción.
sfctl cluster select --endpoint http://testcluster.com:19080
El punto de conexión del clúster debe ir precedido por el prefijo http o https. Debe incluir el puerto para la puerta de enlace HTTP. El puerto y la dirección coinciden con la dirección URL de Service Fabric Explorer.
Para clústeres que están protegidos con un certificado, puede especificar un certificado PEM codificado. El certificado se puede especificar como un único archivo o como un par de certificado y clave. Si es un certificado autofirmado sin firma de una entidad de certificación, puede pasar la opción --no-verify para omitir la comprobación de la entidad de certificación.
sfctl cluster select --endpoint https://testsecurecluster.com:19080 --pem ./client.pem --no-verify
Para más información, consulte Conexión a un clúster seguro de Azure Service Fabric.
Operaciones básicas
La información de la conexión del clúster se mantiene en varias sesiones de la CLI de Service Fabric. Una vez que se selecciona un clúster de Service Fabric, se puede ejecutar cualquier comando de Service Fabric en él.
Por ejemplo, para obtener el estado del clúster de Service Fabric, use el siguiente comando:
sfctl cluster health
El comando devuelve la siguiente salida:
{
"aggregatedHealthState": "Ok",
"applicationHealthStates": [
{
"aggregatedHealthState": "Ok",
"name": "fabric:/System"
}
],
"healthEvents": [],
"nodeHealthStates": [
{
"aggregatedHealthState": "Ok",
"id": {
"id": "66aa824a642124089ee474b398d06a57"
},
"name": "_Test_0"
}
],
"unhealthyEvaluations": []
}
Sugerencias y solución de problemas
Sugerencias y consejos para resolver problemas comunes.
Conversión de un certificado de formato PFX a PEM
La CLI de Service Fabric admite certificados de cliente como archivos PEM (extensión .pem). Si utiliza los archivos PFX de Windows, debe convertir esos certificados al formato PEM. Para convertir un archivo PFX en uno PEM, use el comando siguiente:
openssl pkcs12 -in certificate.pfx -out mycert.pem -nodes
Análogamente, para convertir un archivo PEM en uno PFX, puede usar el siguiente comando (la contraseña no se proporciona aquí):
openssl pkcs12 -export -out Certificates.pfx -inkey Certificates.pem -in Certificates.pem -passout pass:''
Para más información, consulte la documentación de OpenSSL.
Problemas de conexión
Algunas operaciones pueden generar el mensaje siguiente:
Failed to establish a new connection
Compruebe que el punto de conexión del clúster especificado está disponible y a la escucha. Compruebe también que la interfaz de usuario de Service Fabric Explorer está disponible en dicho host y puerto. Use sfctl cluster select para actualizar el punto de conexión.
Registros detallados
Los registros detallados suelen ser útiles para depurar o notificar un problema. La marca --debug aumenta el nivel de detalle de la salida.
Ayuda y sintaxis de los comandos
Para obtener ayuda con un comando específico o un grupo de comandos, use la marca -h.
sfctl application -h
Este es otro ejemplo:
sfctl application create -h
Actualización de la CLI de Service Fabric
Para actualizar la CLI de Service Fabric, ejecute los siguientes comandos (reemplace pip con pip3, según lo que especificara durante la instalación original):
pip uninstall sfctl
pip install sfctl