Directrices de publicación

Los clientes también esperan que las soluciones se entreguen según lo prometido, que incluyan una documentación excelente y que proporcionen una experiencia de soporte eficaz y con poca fricción. En este documento se describe la barra mínima necesaria de los partners de Oracle para su inclusión en Oracle Cloud Marketplace. Se le anima a exceder estas especificaciones, siempre que sea posible. Oracle debe revisar y aprobar las soluciones que incluyen excepciones a estos estándares.

Palabras Clave

Este documento utiliza palabras clave según lo definido por IETF RFC 2119. Para obtener más información, consulte https://www.ietf.org/rfc/rfc2119.txt.

• Debe - Esta palabra, o los términos "Requerido" o "Deberá", significa que la definición es un requisito absoluto de la especificación.
• No debe - Esta frase, o la frase "No debe", significa que la definición es una prohibición absoluta de la especificación.
• Esta palabra, o el adjetivo "Recomendado", significa que puede haber razones válidas en circunstancias particulares para ignorar un tema en particular, pero las implicaciones completas deben ser entendidas y cuidadosamente sopesadas antes de elegir un curso diferente.
• Esta frase, o la frase "No recomendado" significa que puede haber razones válidas en circunstancias particulares cuando el comportamiento en particular es aceptable o incluso útil, pero las implicaciones completas deben ser entendidas y el caso cuidadosamente sopesado antes de implementar cualquier comportamiento descrito con esta etiqueta.
• May - Esta palabra, o el adjetivo "opcional", significa que un elemento es realmente opcional. Un proveedor puede optar por incluir el artículo porque un mercado concreto lo requiere o porque considera que mejora el producto, mientras que otro proveedor puede omitir el mismo artículo. Una implementación que no incluya una opción en particular debe estar preparada para interoperar con otra implementación que sí incluya la opción, aunque tal vez con una funcionalidad reducida. En la misma línea, una implementación que incluya una opción en particular debe estar preparada para interoperar con otra implementación que no incluya la opción (excepto, por supuesto, para la función que proporciona la opción).

Niveles de Gravedad de Vulnerabilidad

Cuando hay alguna referencia a la vulnerabilidad de seguridad en esta sección, la referencia es al sistema de clasificación Common Vulnerability Scoring System (CVSS) v3.0. Para obtener más información sobre CVSS v3.0, consulte https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator.

Seguridad

En la visión general de la seguridad de Oracle Cloud Infrastructure se indica lo siguiente:

We [Oracle] believe that a dynamic security-first culture is vital to building a successful 
security-minded organization. We have cultivated a holistic approach to security culture in which 
all our team members internalize the role that security plays in our business and are
actively engaged in managing and improving our products' security posture. We have also
implemented mechanisms that assist us in creating and maintaining a security-aware culture.

Debe leer y comprender todo el enfoque de seguridad de Oracle Cloud Infrastructure. Consulte la Guía de seguridad de Oracle Cloud Infrastructure en la documentación de Oracle Cloud Infrastructure.

Debe mantener una cultura de seguridad primero que comprenda y valore la confianza de nuestros clientes mutuos.

Controles

Directrices obligatorias

Las siguientes directrices son obligatorias para los listados de aplicaciones en Oracle Cloud Infrastructure Marketplace. Se debe seguir cada directriz. Antes de ser aprobada, cada lista de solicitudes se valida con respecto a cada una de estas directrices.

• El nombre de la aplicación debe tener 80 caracteres o menos. Debe tener 36 caracteres o menos para una visualización óptima.
• El nombre de la aplicación debe ser claro, conciso y libre de errores de ortografía y gramática. No debe tener saltos de línea.
• El Título debe indicar claramente el propósito de la solicitud. Debe ser descrito en dos líneas o menos y estar libre de errores de ortografía y gramática.
• La fuente/espaciado del listado debe ser coherente.
• Todo el texto debe estar libre de errores ortográficos o gramaticales.
• La descripción debe ser completa y capturar el público objetivo/tipo de usuario y explicar por qué el listado es valioso.
• Todos los enlaces deben apuntar a las ubicaciones correctas y abrirse en una nueva ficha o ventana.
• El texto incluido en iconos, banners, capturas de pantalla o vídeos debe ser legible.
• Las imágenes no deben ser borrosas ni estiradas.
• Los documentos relacionados deben proporcionar información coherente para que los usuarios puedan:
  1. Iniciar una instancia desde Marketplace.
  2. Se conectará a la instancia.
  3. Configure o inicie la aplicación.
• La sección Soporte debe contener detalles de contacto precisos para que el cliente interactúe con el soporte de socios. Estos datos de contacto deben contener un número de teléfono o una dirección de correo electrónico precisos.
• Los requisitos del sistema deben contener la lista de componentes necesarios de Oracle Cloud Infrastructure, como unidades de computación, reglas de seguridad, políticas de IAM, volúmenes en bloque, VNIC secundarias, etc.
• Los términos de uso deben incluirse en el paquete de instalación de la aplicación y estar libres de errores ortográficos o gramaticales. El nombre de las condiciones de uso debe estar en mayúsculas. Los enlaces de las Condiciones de uso deben apuntar a las ubicaciones correctas y abrirse en una nueva ficha o ventana.
• La versión del paquete de instalación de la aplicación debe coincidir con la versión especificada en cualquier otra imagen o texto relacionado para este paquete.
• El usuario debe poder iniciar, conectar y configurar la aplicación y la infraestructura relacionada mediante las instrucciones incluidas en las secciones Uso y Documentos relacionados.
• Cada solución publicada incluye un conjunto de documentación orientada al cliente. Esta documentación:
  • Debe incluir instrucciones prominentes y detalladas para conectarse a una instancia.
  • Debe incluir documentación de uso o un enlace a la documentación.
  • Debe incluir detalles de soporte o un enlace a esos detalles.
  • Debe mostrar las unidades compatibles.
  • Debe documentar todos los puertos de red abiertos por defecto en la instancia.
• Reconocimiento: Vd. acepta que no publicará ninguna lista de editores pagada en Oracle Cloud Marketplace si la compra de productos y servicios y/o la prestación de servicios relacionados con el cliente pueden financiarse total o parcialmente con Medicare, Medicaid o cualquier otro programa de atención médica financiado federal o estatal.

Directrices recomendadas

Las siguientes directrices pueden considerarse las mejores prácticas que deben seguirse siempre que sea posible.

• Las notas de la versión se deben especificar como viñetas con saltos de línea adecuados.
• Los documentos relacionados deben contener información sobre cómo comprar una licencia si es necesario.

Instrucciones generales

Aquí hay algunas pautas genéricas para los listados de todos los tipos. Para obtener directrices específicas para los listados de aplicaciones o los listados de imágenes, consulte la sección correspondiente.

• Para garantizar que el contenido de la lista se adapta correctamente al estilo de plataforma cruzada de Oracle Cloud Marketplace, solo se permite el formato básico en las secciones de descripción. Si el contenido se copia desde otro origen de texto enriquecido (como Microsoft Word), asegúrese de eliminar cualquier estilo adicional antes de enviar la lista para su revisión.
• Se recomienda pegar contenido en texto sin formato para evitar incluir estilos y formatos ocultos. Al adherirse a estas opciones básicas de formato, se asegurará de que el contenido de la lista se muestre correctamente en varios dispositivos y plataformas.
• El uso de las marcas comerciales de Oracle incluidas en el contenido del listado (como nombres de productos de Oracle) debe cumplir con las Directrices de uso de terceros para marcas comerciales de Oracle.
• El uso de los logotipos de Oracle en el contenido de la lista (como infografías y capturas de pantalla) debe cumplir con las Directrices de uso de terceros para logotipos de Oracle.
• Para cualquier imagen, como logotipos, iconos o banners:
  • Asegúrese de que el tamaño de las imágenes coincida con las dimensiones especificadas.
  • Guarde imágenes en el formato de archivo especificado con compresión.
  • Asegúrese de que el tamaño del archivo de imagen esté dentro del tamaño de archivo especificado.
  • El banner debe tener 1160 píxeles (ancho) por 200 píxeles (altura), un máximo de 10 MB, y debe ser un archivo BMP, GIF, JPEG (JPG) o PNG.
  • El logotipo de su compañía debe ser de 115 píxeles por 115 píxeles, un máximo de 5 MB, y debe ser un archivo BMP, GIF, JPEG (JPG) o PNG.
  • El icono debe ser de 130 píxeles por 130 píxeles, un máximo de 5 MB, y debe ser un archivo BMP, GIF, JPEG (JPG) o PNG.
  • Los iconos de aplicación deben ser distintivos y únicos. No envíe varias solicitudes con el mismo icono.
  • No utilice ningún logotipo o marca comercial de Oracle en los iconos de la aplicación. Asegúrese de que tiene los derechos de uso de las imágenes de terceros utilizadas.
• El contenido de la sección de descripción debe proporcionar una visión general de alto nivel de la aplicación. Debe describir el valor y el beneficio para el cliente de ejecutar/alojar la aplicación en Oracle Cloud.
• Una descripción larga debe ir precedida de una descripción corta. No repita la descripción corta en la sección de descripción larga.
• En la descripción no se debe resaltar ni hacer referencia a "Oracle Validated Integration". El programa Oracle Validated Integration (OVI) solo se aplica a soluciones locales y no a Oracle Cloud.
• En el campo Información de uso:
  • Incluya un enlace a una guía de introducción que contenga todos los detalles necesarios para que los usuarios comiencen.
  • Incluya enlaces a cualquier documentación técnica, hojas de datos, guías de usuario y otros documentos relacionados (incluidos los que especifique en la sección Documentos relacionados).
  • Muestre los puertos que se deben abrir. Agregue un enlace como "How to configure open ports", que describa los pasos para abrir puertos mediante la consola de Oracle Cloud Infrastructure.
• En el campo Screenshots and Videos, para las capturas de pantalla:
  • Se recomienda un mínimo de dos capturas de pantalla.
  • Al realizar capturas de pantalla, oculte las barras de herramientas y los menús del explorador. Utilice el modo de pantalla completa del explorador.
  • Las dimensiones recomendadas para las capturas de pantalla son 640 píxeles (ancho) x 480 píxeles (altura). Otros tamaños adecuados incluyen 1024x768 y 1200x900. Se debe recortar o cambiar el tamaño de las imágenes más grandes.
  • Para obtener mejores resultados, las imágenes deben crearse con una relación de aspecto nativa de 4:3. Para cualquier imagen que no se ajuste a la relación de aspecto 4:3, como capturas de pantalla de aplicaciones de teléfono móvil, rellene la imagen con un fondo transparente o de color adecuado para que se ajuste al tamaño de imagen requerido. Utilice un editor de imágenes para agregar relleno.
  • Las capturas de pantalla deben tener un máximo de 5 MB y deben ser un archivo BMP, GIF, JPEG (JPG) o PNG.
  • Las imágenes subidas se escalan automáticamente a miniaturas de 240 x 180 píxeles en la página principal del listado.
  • Las imágenes cargadas se escalan automáticamente para adaptarse al visor de medios de 600 x 450 píxeles.
  Para vídeos:
  • Incluya un vídeo de demostración como primer elemento de la lista en el campo Capturas de pantalla y vídeos.
  • Los videos promocionales que se alojan en YouTube o Vimeo se pueden incrustar directamente en la lista de capturas de pantalla y el visor de medios.
  • La dirección URL del vídeo debe comenzar por http:// o por https://
  • El vídeo de demostración principal debe ser corto y directo, centrándose en las principales funciones de la aplicación y el valor de la aplicación/integración en Oracle Cloud.
  • Los videos más largos y el contenido promocional se pueden incluir como videos adicionales.
• En el campo Documentos relacionados:
  • La adición de una hoja de datos específica para la integración de Oracle Cloud es un requisito mínimo.
  • Las hojas de datos deben ser específicas de la versión de la aplicación habilitada para Oracle Cloud.
  • Agregue un documento de introducción a Oracle Cloud Infrastructure que proporcione detalles completos para que los clientes configuren y configuren el software.
• En el campo System Requirements:
  • Muestre los servicios PaaS de Oracle Cloud necesarios para instalar y ejecutar la aplicación.
  • Muestre todos los servicios SaaS de Oracle Cloud con los que está integrada la aplicación.
  • Muestre las dependencias del sistema de terceros.
  • Incluya dependencias específicas del explorador o plataformas móviles soportadas en esta sección.
  • Sea específico sobre cualquier dependencia de versión o edición, o sobre los requisitos de tamaño (si es necesario).

Directrices obligatorias para imágenes de Linux

En la siguiente tabla, se muestran las directrices de imagen obligatorias y el código de error correspondiente. Se debe seguir cada directriz. Antes de publicar una imagen en Oracle Cloud Infrastructure Marketplace, cada imagen se valida en función de cada una de las siguientes directrices obligatorias.

Directrices obligatorias para imágenes de Windows

Directrices recomendadas para imágenes de Linux

Se recomiendan las siguientes directrices para las imágenes que se muestran en Oracle Cloud Infrastructure Marketplace. Cada directriz se considera una mejor práctica que debe seguirse si es posible.

PasswordAuthentication no
ChallengeResponseAuthentication no
UsePAM no

Directrices obligatorias

Las siguientes son directrices obligatorias para las pilas que se muestran en Oracle Cloud Infrastructure Marketplace. Se debe seguir cada directriz. Antes de publicarse, cada artefacto de pila se valida según cada una de estas directrices.

1. El artefacto de pila debe ser un archivo zip, incluidos los archivos de configuración de Terraform y un archivo de esquema.
   • Zip debe incluir al menos un archivo de configuración (.tf) en la carpeta raíz.
   • Zip debe incluir el archivo de esquema (.yaml) en la carpeta raíz.
   • Zip no debe incluir un archivo de estado de Terraform en el archivo zip. Los archivos de estado se gestionan mediante Oracle Resource Manager (ORM). Cuando los clientes inician una pila, ORM crea y gestiona los recursos y el archivo de estado pasa a estar disponible solo para descarga.
   • El zip no debe incluir la carpeta de configuración de tiempo de ejecución de Terraform (.terraform).
2. La configuración de Terraform solo debe utilizar imágenes de instancia que sean imágenes de Marketplace aprobadas o publicadas (públicas o privadas). Debe tener una suscripción de Marketplace a cada una de estas imágenes. Debe tener referencias codificadas para estas imágenes de Marketplace. Consulte Configuración de Terraform de ejemplo para una suscripción y uso de imagen de Marketplace para obtener más información.
3. Los binarios no se deben descargar de repositorios externos. Todos los binarios y dependencias deben incluirse en la imagen publicada de Marketplace.
4. El provisionador de ejecución remota de Terraform solo se debe ejecutar en el dominio de Oracle Cloud Infrastructure. No debe descargar archivos en un servidor remoto.
5. El código de terceros o los binarios no se deben descargar mediante cloud-init.
   1. cloud-init es una utilidad de configuración de inicio que se suele utilizar para las instancias informáticas en la nube. Acepta la configuración mediante mecanismos de datos de usuario especificados como parte de la definición de metadatos en el recurso oci_core_instance.
   2. Hay varios formatos de datos de usuario soportados por cloud-init. Consulte https://cloudinit.readthedocs.io/en/latest/topics/format.html.
   3. Independientemente del formato de datos de usuario, cloud-init NO DEBE utilizarse para descargar ningún código binario o de terceros. Todos los binarios necesarios durante el proceso de inicio de la instancia (bootstrap), si no están disponibles en la imagen, deben descargarse mediante un proceso (script) horneado como parte de la distribución de la imagen, no inyectado a través de cloud-init (por ejemplo, aprovechando wget).)
   4. Sin embargo, puede tener una plantilla cloud-init configurada para que los clientes la utilicen en algunos escenarios concretos, por ejemplo, para importar un archivo de clave de licencia o para importar un archivo de configuración. En ese caso, debe proporcionar una variable en el código de plantilla de Terraform para permitir a los clientes introducir algunos datos en el bloque de creación cloud-init, por ejemplo, aprovechando el origen de datos template_file de Terraform.
6. El proveedor de Terraform debe ser Oracle Cloud Infrastructure. Otros proveedores de servicios en la nube o proveedores de aplicaciones de terceros no están soportados.
7. Si se utiliza un módulo de Terraform, se debe cargar desde rutas de acceso relativas locales. No se puede cargar desde un repositorio remoto.
8. La configuración de Terraform debe utilizar la autenticación de principal de instancia.

9. Debe especificar las versiones de Terraform mínimas y máximas soportadas en las que ha probado la pila.

   • Especifique la versión mínima necesaria de Terraform con el formato: ~> <major_version>.<minor_version>.<patch_version>.

     Donde, patch_version siempre se define en 0. Cuando se inicia una pila, Resource Manager comprueba el <major_version>.<minor_version> que ha definido en el código y utiliza la versión de parche más reciente disponible. Por este motivo, debe utilizar el signo ~> en lugar del signo => al especificar la versión mínima necesaria de Terraform.

     Por ejemplo, ~> 0.14.0 indica que las versiones de Terraform soportadas son 0.14.0 o posteriores.

   • Especifique la versión máxima necesaria de Terraform con el formato: < <major_version>.<minor_version>.

     Por ejemplo, < 0.15 indica que las versiones de Terraform soportadas son anteriores a 0.15.

   En el siguiente ejemplo se muestra cómo especificar las versiones de Terraform mínimas y máximas soportadas cuando haya probado la pila solo en Terraform 0.14.

   terraform 
   { required_version = "~> 0.14.0, < 0.15" }

Para obtener más información sobre Terraform, incluido el proveedor de Oracle Cloud Infrastructure, la autenticación de principal de instancia y el aprovisionador de ejecución remoto, consulte la documentación de Terraform para Configuración de proveedor. Para obtener información sobre las versiones soportadas de Terraform, consulte Introducción al proveedor de Terraform en la documentación de Oracle Cloud Infrastructure.

Directrices de codificación para configuraciones de Terraform

Se recomiendan las siguientes directrices para las pilas que se muestran en Oracle Cloud Infrastructure Marketplace. Cada directriz se considera una mejor práctica que debe seguirse si es posible.

• El artefacto de pila debe permitir a los clientes crear todos los recursos de infraestructura o apuntar a los existentes (red, almacenamiento, etc.).
• Se deben seguir las convenciones de nomenclatura y el formato:
  • Casing: utilice lower_snake_case para todos los nombres. Esto se aplica a nombres de variables, nombres de recursos, nombres de módulos, nombres de archivos, nombres mostrados, etc.
  • Especificación del tipo de recurso: no incluya el tipo de recurso u origen de datos en el nombre. En Terraform, <type>.<name>. siempre hace referencia a los recursos y orígenes de datos Como tal, no hay necesidad de incluir el tipo en el nombre en sí.
  • ID frente a OCID: en Oracle Cloud Infrastructure, id suele hacer referencia a un campo que toma un OCID. Como tal, las variables deben utilizar id al hacer referencia a valores de OCID, en lugar de utilizar ocid.
  • Nombres de variables: los nombres de variables para los recursos de Oracle Cloud Infrastructure suelen utilizar el mismo nombre que se utiliza para el recurso de Terraform.
  • Nombres mostrados: los nombres mostrados de los recursos de Oracle Cloud Infrastructure suelen utilizar el mismo nombre que el utilizado para el recurso de Terraform.
  • Nomenclatura de variables y salidas de módulo: al utilizar un módulo, el nombre de la entrada (variables) y las salidas se deben exponer al emisor de la llamada.
  • terraform fmt se debe aplicar a todo Terraform antes de protegerlo.