github.com/jenkins-x/jx/v2@v2.1.155/pkg/surveyutils/test_data/template/values.tmpl.schema.json (about)

     1  
     2  {
     3    "$id": "https:/jenkins-x.io/tests/descriptionAndTitle.schema.json",
     4    "$schema": "http://json-schema.org/draft-07/schema#",
     5    "description": "install values.yaml",
     6    "type": "object",
     7    "properties": {
     8      "adminUser": {
     9        "type": "object",
    10        "required": [
    11          "username",
    12          "password"
    13        ],
    14        "properties": {
    15          "username": {
    16            "type": "string",
    17            "title": "Jenkins X Admin Username",
    18            "description": "The Admin Username will be used by all services installed by Jenkins X",
    19            "default": "admin"
    20          },
    21          "password": {
    22            "type": "string",
    23            "format": "password",
    24            "title": "Jenkins X Admin Password",
    25            "description": "The Admin Password will be used by all services installed by Jenkins X"
    26          }
    27        }
    28      },
    29      "prow": {
    30        "type": "object",
    31        "properties": {
    32          "hmacToken": {
    33            "type": "string",
    34            "format": "token",
    35            "title": "HMAC token",
    36            "description": "The HMAC token is used to validate incoming webhooks, TODO"
    37          }
    38        }
    39      },
    40  {{- if eq .GitKind "github" }}
    41      "pipelineUser": {
    42        "type": "object",
    43        "required": [
    44          "username",
    45          "token"
    46        ],
    47        "properties": {
    48          "username": {
    49            "type": "string",
    50            "title": "Pipeline bot Git username",
    51            "description": "The Git user that will perform git operations inside a pipeline. It should be a user within the Git organisation/owner where environment repositories will live. This is normally a bot."
    52          },
    53          "token": {
    54            "type": "string",
    55            "format": "token",
    56            "title": "Pipeline bot Git token",
    57            "description": "A token for the Git user that will perform git operations inside a pipeline. This includes environment repository creation, and so this token should have full repository permissions. To create a token go to {{ .GitServer }}/settings/tokens/new?scopes=repo,read:user,read:org,user:email,write:repo_hook,delete_repo then enter a name, click Generate token, and copy and paste the token into this prompt.",
    58            "minLength": 40,
    59            "maxLength": 40,
    60            "pattern": "^[0-9a-f]{40}$"
    61          }
    62        }
    63      },
    64  {{- else if eq .GitKind "bitbucketserver" }}
    65      "pipelineUser": {
    66        "type": "object",
    67        "required": [
    68          "username",
    69          "token"
    70        ],
    71        "properties": {
    72          "username": {
    73            "type": "string",
    74            "title": "Pipeline bot Git username",
    75            "description": "The Git user that will perform git operations inside a pipeline. It should be a user within the Git organisation/owner where environment repositories will live. This is normally a bot."
    76          },
    77          "token": {
    78            "type": "string",
    79            "format": "token",
    80            "title": "Pipeline bot Git token",
    81            "description": "A token for the Git user that will perform git operations inside a pipeline. This includes environment repository creation, and so this token should have full repository permissions. To create a token go to {{ .GitServer }}/plugins/servlet/access-tokens/manage then enter a name, click Generate token, and copy and paste the token into this prompt.",
    82            "minLength": 8,
    83            "maxLength": 50
    84          }
    85        }
    86      },
    87  {{- else if eq .GitKind "gitlab" }}
    88      "pipelineUser": {
    89        "type": "object",
    90        "required": [
    91          "username",
    92          "token"
    93        ],
    94        "properties": {
    95          "username": {
    96            "type": "string",
    97            "title": "Pipeline bot Git username",
    98            "description": "The Git user that will perform git operations inside a pipeline. It should be a user within the Git organisation/owner where environment repositories will live. This is normally a bot."
    99          },
   100          "token": {
   101            "type": "string",
   102            "format": "token",
   103            "title": "Pipeline bot Git token",
   104            "description": "A token for the Git user that will perform git operations inside a pipeline. This includes environment repository creation, and so this token should have full repository permissions. To create a token go to {{ .GitServer }}/profile/personal_access_tokens then enter a name, click Generate token, and copy and paste the token into this prompt.",
   105            "minLength": 8,
   106            "maxLength": 50
   107          }
   108        }
   109      },
   110  {{- else }}
   111      "pipelineUser": {
   112        "type": "object",
   113        "required": [
   114          "username",
   115          "token"
   116        ],
   117        "properties": {
   118          "username": {
   119            "type": "string",
   120            "title": "Pipeline bot Git username",
   121            "description": "The Git user that will perform git operations inside a pipeline. It should be a user within the Git organisation/owner where environment repositories will live. This is normally a bot."
   122          },
   123          "token": {
   124            "type": "string",
   125            "format": "token",
   126            "title": "Pipeline bot Git token",
   127            "description": "A token for the Git user that will perform git operations inside a pipeline. This includes environment repository creation, and so this token should have full repository permissions. To create a token go to {{ .GitServer }}/settings/tokens/new?scopes=repo,read:user,read:org,user:email,write:repo_hook,delete_repo then enter a name, click Generate token, and copy and paste the token into this prompt.",
   128            "minLength": 8,
   129            "maxLength": 50
   130          }
   131        }
   132      },
   133  {{- end }}
   134      "enableDocker": {
   135        "type": "boolean",
   136        "title": "Do you want to configure a Docker Registry?",
   137        "description": "TODO"
   138      },
   139      "enableGpg": {
   140        "type": "boolean",
   141        "title": "Do you want to configure a GPG Key?",
   142        "description": "TODO"
   143      }
   144    },
   145    "allOf": [
   146      {
   147        "if": {
   148          "properties": {
   149            "enableDocker": {
   150              "const": "true",
   151              "type": "boolean"
   152            }
   153          }
   154        },
   155        "then": {
   156          "properties": {
   157            "docker": {
   158              "type": "object",
   159              "properties": {
   160                "url": {
   161                  "type": "string",
   162                  "title": "Docker Registry URL",
   163                  "default": "https://index.docker.io/v1/"
   164                },
   165                "username": {
   166                  "type": "string",
   167                  "title": "Docker Registry username",
   168                  "description": "TODO"
   169                },
   170                "password": {
   171                  "type": "string",
   172                  "format": "password",
   173                  "title": "Docker Registry password",
   174                  "description": "TODO"
   175                }
   176              }
   177            }
   178          }
   179        }
   180      },
   181      {
   182        "if": {
   183          "properties": {
   184            "enableGpg": {
   185              "const": "true",
   186              "type": "boolean"
   187            }
   188          }
   189        },
   190        "then": {
   191          "properties": {
   192            "gpg": {
   193              "type": "object",
   194              "properties": {
   195                "passphrase": {
   196                  "type": "string",
   197                  "format": "password",
   198                  "title": "GPG Passphrase",
   199                  "description": "TODO"
   200                }
   201              }
   202            }
   203          }
   204        }
   205      }
   206    ]
   207  }