Préparation du fichier de configuration

Après avoir configuré l'environnement AppScan 360° et avant l'installation, préparez le fichier de configuration, singular-singular.clusterKit.properties ou singular-singular.clusterKit.yaml. Il s'agit du fichier auquel la plateforme centrale AppScan 360° et les fichiers d'installation Conseils de résolution AppScan sont référencés lors de l'installation.

Pour préparer le fichier de configuration :
  1. Créez un nouveau fichier dans l'éditeur de texte de votre choix.
  2. Remplissez le fichier avec les paramètres appropriés comme décrit dans le tableau ci-dessous.
    Remarque : Vous pouvez fournir un certificat de serveur dans le cadre du fichier de personnalisation à utiliser comme certificat de point d'entrée de service. Si ce certificat est utilisé, il doit être fourni en tant que certificat structuré PEM, comme suit :
    • Clé publique dans le fichier *.crt ou *.cer
    • Clé privée dans le fichier *.key
  3. Nommez le fichier singular-singular.clusterKit.properties ou singular-singular.clusterKit.yaml, en fonction de votre méthode d'installation, et enregistrez-le dans le dossier dans lequel vous avez enregistré ou prévoyez d'enregistrer le kit d'installation.
    Remarque : Le fichier d'installation auto-extractible doit pouvoir localiser ce fichier pendant le processus d'installation.

Remarques de configuration

Vous pouvez fournir un certificat de serveur dans le cadre du fichier de personnalisation à utiliser comme certificat de point d'entrée de service. Si ce certificat est utilisé, il doit être fourni en tant que certificat structuré PEM, comme suit :
  • Clé publique dans le fichier *.crt ou *.cer
  • Clé privée dans le fichier *.key

Paramètres de configuration

Remarque : Placez toutes les valeurs de paramètres entre guillemets.
Conseil : Cliquez sur la flèche vers la droite (>) en haut à droite de cette page pour développer le contenu du tableau.
Paramètre Description Exemple de valeur
CK_DOCKER_REGISTRY_ADDRESS Adresse de registre d'images Docker (FQDN), éventuellement avec un port, séparé par deux points pi-dpr-lin.appscan.com
CK_DOCKER_REGISTRY_USERNAME Nom d'utilisateur du registre d'images Docker
CK_DOCKER_REGISTRY_PASSWORD Mot de passe du registre d'images Docker
CK_CNI_NETWORK_DOMAIN_SUFFIX Nom de service du domaine désigné appscan.com
CK_CSI_STORAGE_CLASS_NAME Nom de la classe du pilote de stockage Kubernetes longhorn
CK_CSI_STORAGE_SHARED_FILE_SYSTEM_VOLUME_NAME

PV (Persistent Volume) prédéfini par Kubernetes à utiliser avec le PVC (Persistent Volume Claim) généré automatiquement pour le système de fichiers partagé.

Remarque :
  • Facultatif. Si non remplie, le PV désigné est généré automatiquement par le PVC.
  • Cette fonctionnalité est généralement utilisée en cas de migration à partir de la version basée sur la machine virtuelle Windows de AppScan 360°, et si les données existantes (partagées) doivent être conservées.
CK_CSI_STORAGE_SHARED_FILE_SYSTEM_REQUESTED_CAPACITY Taille désignée du stockage partagé Kubernetes, à calculer avant l'installation, en suivant la logique de calcul décrite dans 100Gi
CK_INGRESS_CONTROLLER_CAPABILITIES_IS_HTTPS_BACKEND_PROTOCOL_SUPPORTED Indique si le contrôleur d'entrée est basé sur NGINX, ou si le chargement SSL (protocole back-end HTTPS) est pris en charge par le contrôleur d'entrée (pas via une annotation, mais par le contrôleur lui-même). false
CK_INGRESS_INTERNAL_CLASS Nom de classe d'entrée à utiliser lors du déploiement d'adresses dans le cluster Kubernetes. nginx
CK_INGRESS_INTERNAL_HOST_DOMAIN

Domaine à utiliser lors du déploiement d'adresses dans le cluster Kubernetes pour la création du nom d'hôte.

Remarque : Si le domaine n'est pas rempli, il sera extrait de CK_CNI_NETWORK_DOMAIN_SUFFIX
appscan.com
CK_INGRESS_INTERNAL_HOST_SUBDOMAIN Sous-domaine à utiliser lors du déploiement d'adresses dans le cluster Kubernetes pour la création du nom d'hôte. expo.ascp
CK_CUSTOMER_INGRESS_CERTIFICATE_ENABLED Indique s'il faut utiliser un certificat donné comme certificats d'entrée de microservices externes (hors cluster) applicables.
Remarque : Fournissez un certificat de serveur dans le cadre du fichier de personnalisation à utiliser comme certificat d'entrée de service, ou fournissez le certificat en tant que certificat structuré PEM, comme suit :
  • Clé publique dans le fichier .crt ou .cer

  • Clé privée dans le fichier .key
false
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_CA_CRT_AS_BASE64 Certificat de signature de l'autorité de certification (AC) fourni pour le certificat utilisé comme certificat d'entrée des microservices externes (hors cluster). <BASE64_ENCODED_VALUE>
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_TLS_CRT_AS_BASE64 Clé publique fournie du certificat utilisé comme certificats d'entrée de microservices externes (hors cluster) applicables. <BASE64_ENCODED_VALUE>
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_TLS_KEY_AS_BASE64 Clé privée fournie du certificat utilisé comme certificats d'entrée de microservices externes (hors cluster) applicables. <BASE64_ENCODED_VALUE>
CK_CONFIGURATION_DISCLOSED_SITE_URL AppScan 360° URL front-end.
Remarque : N'incluez pas de barre oblique (/) dans l'URL.
https://expo.ascp.appscan.com
CK_CONFIGURATION_DISCLOSED_EXTERNAL_IDP_MODE
Définissez votre méthode d'intégration des nouveaux utilisateurs :
  • AutoOnboard : Tout utilisateur ayant accès au serveur peut se connecter à AppScan 360°.
  • GroupsAccess : Tout utilisateur d'un groupe autorisé (défini ci-dessous) peut se connecter à AppScan 360°.
  • ManualOnboard : Les utilisateurs doivent être invités à l'aide du bouton Ajouter des utilisateurs de la page Gestion des accès > Utilisateurs.
AutoOnboard
CK_CONFIGURATION_DISCLOSED_LDAP_DOMAIN Serveur LDAP/domaine de service.
Important : Lors de la mise à niveau à partir de AppScan 360° version 1.1.0 ou antérieure, la configuration LDAP ne peut pas être utilisée à nouveau telle quelle. Vous devez vérifier que tous les paramètres LDAP répondent aux exigences actuelles/mises à jour de AppScan 360° avant de procéder à l'installation.
appscan.il
CK_CONFIGURATION_DISCLOSED_LDAP_USERNAME Nom d'utilisateur du serveur/service LDAP pour établir la connexion.
Remarque : Pertinent lorsque « ManualOnboard » est sélectionné pour CK_CONFIGURATION_DISCLOSED_EXTERNAL_IDP_MODE.
<LDAP_USERNAME>
CK_CONFIGURATION_DISCLOSED_LDAP_AUTHORIZED_GROUPS

Liste des groupes LDAP du client (séparés par des virgules) auxquels l'accès est autorisé. AppScan 360°

Remarque : Pertinent lorsque « GroupsAccess » est indiqué pour CK_CONFIGURATION_DISCLOSED_EXTERNAL_IDP_MODE.
CK_CONFIGURATION_DISCLOSED_LDAP_SSL Indique s'il faut établir une connexion sécurisée (via SSL/TLS) vers un serveur/service LDAP. false
CK_CONFIGURATION_DISCLOSED_LDAP_TARGET_OU Emplacement désigné des utilisateurs dans l'AD (Active Directory) pour les requêtes LDAP. Utilisé pour authentifier les utilisateurs AD lors de la connexion à AppScan 360°. Users,DC=appscan,DC=com
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_HOST Nom d'hôte du service/serveur de messagerie SMTP. wfilsus.israel.ottawa.watchfire.com
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_PORT Serveur de messagerie SMTP/port de service. 25
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_USERNAME Nom d'utilisateur du service/serveur de messagerie SMTP pour établir la connexion. <SMTP_USERNAME>
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_ENABLE_SSL Indique s'il faut établir une connexion sécurisée (via SSL/TLS) vers un serveur/service de messagerie SMTP. false

CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_HOST

Facultatif. Nom d'hôte du proxy en amont dédié.

10.255.255.255
CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_PORT Facultatif. Port d'un proxy en amont dédié. 3762
CK_CONFIGURATION_CONFIDENTIAL_UPSTREAM_PROXY_USERNAME Facultatif. Nom d'utilisateur d'un proxy en amont dédié. ProxyUserName
CK_CONFIGURATION_CONFIDENTIAL_DEFAULT_CONNECTION Chaîne de connexion MSSQL du datastore (base de données) utilisée pour établir une connexion avec la base de données. <DB_CONNECT_STRING>
CK_CONFIGURATION_CONFIDENTIAL_LDAP_PASSWORD

Mot de passe du serveur/service LDAP pour établir la connexion.

Remarque : Pertinent lorsque « ManualOnboard » est indiqué pour «CK_CONFIGURATION_DISCLOSED_EXTERNAL_IDP_MODE.
<LDAP_PASSWORD>
CK_CONFIGURATION_CONFIDENTIAL_MAIL_SMTP_PASSWORD Mot de passe du service/serveur de messagerie SMTP pour établir la connexion. <SMTP_PASSWORD>
CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_PASSWORD Facultatif. Mot de passe d'un proxy en amont dédié. <PROXY_PASSWORD>

Exemple singular-singular.clusterKit.properties

#
## Docker Registry info
#

CK_DOCKER_REGISTRY_ADDRESS='pi-dpr-lin.appscan.com'
CK_DOCKER_REGISTRY_USERNAME='user'
CK_DOCKER_REGISTRY_PASSWORD='password'

#
## Network info
#

CK_CNI_NETWORK_DOMAIN_SUFFIX='appscan.com'

#
## Storage info
#

CK_CSI_STORAGE_CLASS_NAME='longhorn'
CK_CSI_STORAGE_SHARED_FILE_SYSTEM_VOLUME_NAME=''
CK_CSI_STORAGE_SHARED_FILE_SYSTEM_REQUESTED_CAPACITY='100Gi'

#
## Ingress info
#

CK_INGRESS_CONTROLLER_CAPABILITIES_IS_HTTPS_BACKEND_PROTOCOL_SUPPORTED='false'
CK_INGRESS_INTERNAL_CLASS='nginx'
CK_INGRESS_INTERNAL_HOST_DOMAIN='appscan.com'
CK_INGRESS_INTERNAL_HOST_SUBDOMAIN='expo.ascp'

#
## Customer certificate info 
#

CK_CUSTOMER_INGRESS_CERTIFICATE_ENABLED='false'
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_CA_CRT_AS_BASE64='   '
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_TLS_CRT_AS_BASE64='  '
CK_CUSTOMER_INGRESS_CERTIFICATE_SECRET_DATA_TLS_KEY_AS_BASE64='  '

#
## Configuration/Disclosed info
#

CK_CONFIGURATION_DISCLOSED_SITE_URL='https://expo.ascp.appscan.com'
CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_HOST=''
CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_PORT=''
CK_CONFIGURATION_DISCLOSED_UPSTREAM_PROXY_USERNAME=''
CK_CONFIGURATION_DISCLOSED_EXTERNAL_IDP_MODE='AutoOnboard'
CK_CONFIGURATION_DISCLOSED_LDAP_DOMAIN='appscan.com'
CK_CONFIGURATION_DISCLOSED_LDAP_USERNAME='labmgr'
CK_CONFIGURATION_DISCLOSED_LDAP_AUTHORIZED_GROUPS=''
CK_CONFIGURATION_DISCLOSED_LDAP_SSL='false'
CK_CONFIGURATION_DISCLOSED_LDAP_TARGET_OU='CN=Users,DC=appscan,DC=com'
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_HOST='wfilsus.israel.ottawa.watchfire.com'
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_PORT='25'
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_USERNAME='admin@abcd'
CK_CONFIGURATION_DISCLOSED_MAIL_SMTP_ENABLE_SSL='false'

#
## Configuration/Confidential info
#

CK_CONFIGURATION_CONFIDENTIAL_DEFAULT_CONNECTION='Data Source=mssql-service.expo.ascp.appscan.com;Initial Catalog=AppScanCloudDB;User ID=ABC;Password=1234;MultipleActiveResultSets=True;TrustServerCertificate=True'
CK_CONFIGURATION_CONFIDENTIAL_LDAP_PASSWORD='12345678Abcdefg'
CK_CONFIGURATION_CONFIDENTIAL_MAIL_SMTP_PASSWORD='ABC!@#123'
CK_CONFIGURATION_CONFIDENTIAL_UPSTREAM_PROXY_PASSWORD=''

Exemple singular-singular.clusterKit.yaml

# Default values for ascp-dart-prime.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

#
# Settings that need to be customized by the customer are marked with 'CUSTOMIZE_ME' comments
#
global:
  # customer:
  #   certificate:
  #     ingress:
  #       # CUSTOMIZE_ME:
  #       # Indication whether to use a customer given certificate as the applicable external (out-of-cluster) micro services ingresses certificates, or not
  #       enabled: false
  #       secret:
  #         data:
  #           # CUSTOMIZE_ME:
  #           # The customer's supplied certificate authority (CA) signing certificate of the certificate used as the applicable external (out-of-cluster) micro services ingresses certificates
  #           caCrtAsBase64: ''
  #           # CUSTOMIZE_ME:
  #           # The customer's supplied public key of the certificate used as the applicable external (out-of-cluster) micro services ingresses certificates
  #           tlsCrtAsBase64: ''
  #           # CUSTOMIZE_ME:
  #           # The customer's supplied private key of the certificate used as the applicable external (out-of-cluster) micro services ingresses certificates
  #           tlsKeyAsBase64: ''
  workload:
    dockerPrivateRegistry:
      secret:
        enabled: true
        name: ascp-docker-registry-secret
        data:
          # Auto generated Docker private registry user credentials configuration
          jsonConfigAsBase64: ""
  storage:
    pvc:
      linux:
        enabled: true
        # The customer's K8S storage driver access mode
        #   NOTE: Set on 'ReadWriteMany' and should not be changed
        accessMode: ReadWriteMany
        # CUSTOMIZE_ME:
        # The customer's K8S storage driver class name
        #   NOTE: The CSI driver must support 'ReadWriteMany' access mode
#       storageClassName: freenas-nfs-csi
        storageClassName: longhorn
        # CUSTOMIZE_ME:
        # The customer's K8S predefined PV (Persistent Volume), to be used with the auto-generated PVC (Persistent Volume Claim) for the shared file system
        #   NOTES:
        #   1. This field is optional, if left empty, the designated PV will be generated automatically by the PVC
        #   2. This ability is generally used in case migrating from the Windows VM based version of AppScan 360°, and there is a need to keep the existing (shared) data
        #   3. Note: In case the PV is NOT intended to be associated with any storage class, do the following:
        #     3.1 The storage class name parameter (CK_CSI_STORAGE_CLASS_NAME) should be set to a pseudo one (e.g., 'manual')
        #     3.2 The PV should be set in the same way (regarding its storage-class parameter) as the PVC
        volumeName: null
        # CUSTOMIZE_ME:
        # The customer's K8S shared storage designated size, to be calculated before installation, following the calculation logic outlined in the formal documentation
        requestedCapacity: 50Gi
  ca:
    seed:
      enabled: true
      issuer:
        name: appscan-seed-ca-clusterissuer
        kind: ClusterIssuer
    root:
      secret:
        data:
          # Auto generated root CA certificate
          tlsCrtAsBase64: null
          # Auto generated root CA private key
          tlsKeyAsBase64: null
      certificate:
        name: appscan-root-ca-cert
        duration: 26280h0m0s # 3 years
        renewBefore: 8760h0m0s # 1 year
  # ingress:
  #   controller:
  #     capabilities:
  #       # CUSTOMIZE_ME:
  #       # Indicates whether the Ingress Controller is based on NGINX, or the SSL onload (HTTPS backend protocol) is supported by the ingress controller (not via an annotation, but by the controller itself!), or not
  #       isHttpsBackendProtocolSupported: true
  #   internal:
  #     # CUSTOMIZE_ME:
  #     # The ingress class name to be used when deploying ingresses into the customer's K8S cluster
  #     class: nginx
  #     host:
  #       # CUSTOMIZE_ME:
  #       # The (main) domain to be used when deploying ingresses into the customer's K8S cluster (for building the host name)
  #       #   NOTE: If left empty, it will be taken from the 'global.network.domainSuffix' field
  #       domain: appscan.com
  #       # CUSTOMIZE_ME:
  #       # The sub domain to be used when deploying ingresses into the customer's K8S cluster (for building the host name)
  #       subDomain: as360
  network:
    # CUSTOMIZE_ME:
    # The customer's designated (main) domain name
    domainSuffix: appscan.com
  configuration:
    disclosed:
      # CUSTOMIZE_ME:
      # AS360 frontend URL (of the UI)
      #   NOTE: The URL must NOT have a trailing '/' at the end of the URL (A valid example: 'https://mydomain.server.com', an invalid example: 'https://mydomain.server.com/')
      siteUrl: ''
      # CUSTOMIZE_ME:
      # The customer's LDAP server/service domain
      ldapDomain: ''
      # CUSTOMIZE_ME:
      # The customer's LDAP server/service user name (for establishing connection)
      #   NOTE: Relevant IFF 'ManualOnboard' is selected for the 'global.configuration.externalIDPMode' parameter
      ldapUsername: ''
      # CUSTOMIZE_ME:
      # The customer's list of LDAP groups (comma-separated) that are authorized to access the AppScan 360°
      #   NOTE: Relevant IFF 'GroupsAccess' is selected for the 'global.configuration.externalIDPMode' parameter
      ldapAuthorizedGroups: ''
      # CUSTOMIZE_ME:
      # Indicates whether to establish a secured (over SSL/TLS) connection towards the customer's LDAP server/service, or not
      #   NOTE: Valid values are 'True' or 'False'
      ldapSsl: ''
      # CUSTOMIZE_ME:
      # The customer's designated location of the users in the its AD (Active Directory) for LDAP queries, it is used to authenticate AD users during login to AppScan 360°
      ldapTargetOU: ''
      # CUSTOMIZE_ME:
      # The customer's SMTP mail server/service host name
      mailSmtpHost: ''
      # CUSTOMIZE_ME:
      # The customer's SMTP mail server/service port
      mailSmtpPort: ''
      # CUSTOMIZE_ME:
      # The customer's SMTP mail server/service user name (for establishing connection)
      mailSmtpUserName: ''
      # CUSTOMIZE_ME:
      # Indicates whether to establish a secured (over SSL/TLS) connection towards the customer's SMTP mail server/service, or not
      #   NOTE: Valid values are 'True' or 'False'
      mailSmtpEnableSsl: ''
      # CUSTOMIZE_ME:
      # Define your method for onboarding new users:
      #   AutoOnboard: Any user with access to the server can log in to AppScan 360°.
      #   GroupsAccess: Any user in an authorized group (defined below) can log in to AppScan 360°.
      #   ManualOnboard: Users must be invited using the Add Users button on the Access management > Users page.
      externalIDPMode: ''
      # CUSTOMIZE_ME:
      # Optional set of parameters, to be used IFF the customer has a dedicated upstream proxy (used to enable Internet access from within the customer's network),
      # holding the customer's upstream proxy settings (for establishing connection), if applicable.
      #   NOTES:
      #     1. Currently there is NO support using a script to configure the upstream proxy settings
      # The customer's upstream proxy host (an optional parameter, to be used IFF the customer has a dedicated upstream proxy)
      upstreamProxyHost: ''
      # CUSTOMIZE_ME:
      # The customer's upstream proxy port (an optional parameter, to be used IFF the customer has a dedicated upstream proxy)
      upstreamProxyPort: ''
      # CUSTOMIZE_ME:
      # The customer's upstream proxy username (an optional parameter, to be used IFF the customer has a dedicated upstream proxy)
      upstreamProxyUsername: ''
    confidential:
      # CUSTOMIZE_ME:
      # The customer's MSSQL data store (database) connection string (used to established a connection with the database)
      defaultConnection: ''
      # CUSTOMIZE_ME:
      # The customer's LDAP server/service password (for establishing connection)
      #   NOTE: Relevant IFF 'ManualOnboard' is selected for the 'global.configuration.externalIDPMode' parameter
      ldapPassword: ''
      # CUSTOMIZE_ME:
      # The customer's SMTP mail server/service password (for establishing connection)
      mailSmtpPassword: ''
      # CUSTOMIZE_ME:
      # The customer's upstream proxy password (for establishing connection), an optional parameter, to be used IFF the customer has a dedicated upstream proxy
      upstreamProxyPassword: ''
      #
      # Below entries are not required for ASOP/AS360
      #
      opsConsoleDPKey : ''
      oktaClientSecret: ''
      oktaApiToken: ''
      licenseApiKey: ''
      githubClientSecret: ''
common:
  ingress:
    enabled: false
  service:
    enabled: false
  helmHooks:
    rbacBaseName: helm-hooks-rbac

ascp-user-portal-ui:
  enabled: true

ascp-domain-challenger:
  enabled: true

ascp-egress-gatekeeper:
  enabled: true

ascp-mr-tasks-manager:
  enabled: true

ascp-mr-user-api:
  enabled: true

ascp-mr-scanners-api:
  enabled: true

ascp-mr-presence-api:
  enabled: true