docs(core): remove on-premise docs (#28730)
Removes the on-premise docs in favor single tenant and the nrwl/nx-cloud-helm repo
This commit is contained in:
Isaac Mann
GitHub
parent
d960ddd40f
commit
d4f4dac2eb
@ -770,128 +770,6 @@
|
||||
"path": "/ci/recipes/enterprise/single-tenant",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "on-premise",
|
||||
"name": "On-Premise",
|
||||
"description": "Manage an on-premise installation of Nx Cloud",
|
||||
"mediaImage": "",
|
||||
"file": "",
|
||||
"itemList": [
|
||||
{
|
||||
"id": "on-premise",
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"tags": ["on-premise"]
|
||||
},
|
||||
{
|
||||
"id": "auth-single-admin",
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-single-admin",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-github",
|
||||
"name": "Authenticate with GitHub",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-github",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "ami-setup",
|
||||
"name": "On-Prem VM Setup",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/ami-setup",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-gitlab",
|
||||
"name": "Authenticate with GitLab",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-gitlab",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket",
|
||||
"name": "Authenticate with BitBucket",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-saml",
|
||||
"name": "Authenticate via SAML",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-saml",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "advanced-config",
|
||||
"name": "Advanced Configuration",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/advanced-config",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "custom-github-app",
|
||||
"name": "Custom GitHub App",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/custom-github-app",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"tags": []
|
||||
}
|
||||
],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "dte",
|
||||
"name": "Custom Distributed Task Execution",
|
||||
@ -1454,128 +1332,6 @@
|
||||
"path": "/ci/recipes/enterprise/single-tenant",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "on-premise",
|
||||
"name": "On-Premise",
|
||||
"description": "Manage an on-premise installation of Nx Cloud",
|
||||
"mediaImage": "",
|
||||
"file": "",
|
||||
"itemList": [
|
||||
{
|
||||
"id": "on-premise",
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"tags": ["on-premise"]
|
||||
},
|
||||
{
|
||||
"id": "auth-single-admin",
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-single-admin",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-github",
|
||||
"name": "Authenticate with GitHub",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-github",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "ami-setup",
|
||||
"name": "On-Prem VM Setup",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/ami-setup",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-gitlab",
|
||||
"name": "Authenticate with GitLab",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-gitlab",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket",
|
||||
"name": "Authenticate with BitBucket",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-saml",
|
||||
"name": "Authenticate via SAML",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-saml",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "advanced-config",
|
||||
"name": "Advanced Configuration",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/advanced-config",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "custom-github-app",
|
||||
"name": "Custom GitHub App",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/custom-github-app",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"tags": []
|
||||
}
|
||||
],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "dte",
|
||||
"name": "Custom Distributed Task Execution",
|
||||
@ -1825,238 +1581,6 @@
|
||||
"path": "/ci/recipes/enterprise/single-tenant/custom-github-app",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise": {
|
||||
"id": "on-premise",
|
||||
"name": "On-Premise",
|
||||
"description": "Manage an on-premise installation of Nx Cloud",
|
||||
"mediaImage": "",
|
||||
"file": "",
|
||||
"itemList": [
|
||||
{
|
||||
"id": "on-premise",
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"tags": ["on-premise"]
|
||||
},
|
||||
{
|
||||
"id": "auth-single-admin",
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-single-admin",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-github",
|
||||
"name": "Authenticate with GitHub",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-github",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "ami-setup",
|
||||
"name": "On-Prem VM Setup",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/ami-setup",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-gitlab",
|
||||
"name": "Authenticate with GitLab",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-gitlab",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket",
|
||||
"name": "Authenticate with BitBucket",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "auth-saml",
|
||||
"name": "Authenticate via SAML",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-saml",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "advanced-config",
|
||||
"name": "Advanced Configuration",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/advanced-config",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"tags": []
|
||||
},
|
||||
{
|
||||
"id": "custom-github-app",
|
||||
"name": "Custom GitHub App",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/custom-github-app",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"tags": []
|
||||
}
|
||||
],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/on-premise": {
|
||||
"id": "on-premise",
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"tags": ["on-premise"]
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-single-admin": {
|
||||
"id": "auth-single-admin",
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-single-admin",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-github": {
|
||||
"id": "auth-github",
|
||||
"name": "Authenticate with GitHub",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-github",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/ami-setup": {
|
||||
"id": "ami-setup",
|
||||
"name": "On-Prem VM Setup",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/ami-setup",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-gitlab": {
|
||||
"id": "auth-gitlab",
|
||||
"name": "Authenticate with GitLab",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-gitlab",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-bitbucket": {
|
||||
"id": "auth-bitbucket",
|
||||
"name": "Authenticate with BitBucket",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center": {
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/auth-saml": {
|
||||
"id": "auth-saml",
|
||||
"name": "Authenticate via SAML",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-saml",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/advanced-config": {
|
||||
"id": "advanced-config",
|
||||
"name": "Advanced Configuration",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/advanced-config",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/on-premise/custom-github-app": {
|
||||
"id": "custom-github-app",
|
||||
"name": "Custom GitHub App",
|
||||
"description": "",
|
||||
"mediaImage": "",
|
||||
"file": "nx-cloud/enterprise/on-premise/custom-github-app",
|
||||
"itemList": [],
|
||||
"isExternal": false,
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"tags": []
|
||||
},
|
||||
"/ci/recipes/enterprise/dte": {
|
||||
"id": "dte",
|
||||
"name": "Custom Distributed Task Execution",
|
||||
|
||||
@ -5961,95 +5961,6 @@
|
||||
],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"id": "auth-single-admin",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitHub",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"id": "auth-github",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Prem VM Setup",
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"id": "ami-setup",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitLab",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"id": "auth-gitlab",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"id": "auth-bitbucket",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate via SAML",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"id": "auth-saml",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"id": "advanced-config",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom GitHub App",
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"id": "custom-github-app",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
}
|
||||
],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom Distributed Task Execution",
|
||||
"path": "/ci/recipes/enterprise/dte",
|
||||
@ -6460,95 +6371,6 @@
|
||||
],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"id": "auth-single-admin",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitHub",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"id": "auth-github",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Prem VM Setup",
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"id": "ami-setup",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitLab",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"id": "auth-gitlab",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"id": "auth-bitbucket",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate via SAML",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"id": "auth-saml",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"id": "advanced-config",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom GitHub App",
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"id": "custom-github-app",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
}
|
||||
],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom Distributed Task Execution",
|
||||
"path": "/ci/recipes/enterprise/dte",
|
||||
@ -6730,175 +6552,6 @@
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"id": "auth-single-admin",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitHub",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"id": "auth-github",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Prem VM Setup",
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"id": "ami-setup",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitLab",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"id": "auth-gitlab",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"id": "auth-bitbucket",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate via SAML",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"id": "auth-saml",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"id": "advanced-config",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom GitHub App",
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"id": "custom-github-app",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
}
|
||||
],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise",
|
||||
"id": "on-premise",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
|
||||
"id": "auth-single-admin",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitHub",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-github",
|
||||
"id": "auth-github",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "On-Prem VM Setup",
|
||||
"path": "/ci/recipes/enterprise/on-premise/ami-setup",
|
||||
"id": "ami-setup",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitLab",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-gitlab",
|
||||
"id": "auth-gitlab",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket",
|
||||
"id": "auth-bitbucket",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center",
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Authenticate via SAML",
|
||||
"path": "/ci/recipes/enterprise/on-premise/auth-saml",
|
||||
"id": "auth-saml",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"path": "/ci/recipes/enterprise/on-premise/advanced-config",
|
||||
"id": "advanced-config",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom GitHub App",
|
||||
"path": "/ci/recipes/enterprise/on-premise/custom-github-app",
|
||||
"id": "custom-github-app",
|
||||
"isExternal": false,
|
||||
"children": [],
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"name": "Custom Distributed Task Execution",
|
||||
"path": "/ci/recipes/enterprise/dte",
|
||||
|
||||
@ -1197,15 +1197,6 @@
|
||||
"path": "/ci/recipes/enterprise/single-tenant/overview"
|
||||
}
|
||||
],
|
||||
"on-premise": [
|
||||
{
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem",
|
||||
"id": "on-premise",
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"path": "/ci/recipes/enterprise/on-premise/on-premise"
|
||||
}
|
||||
],
|
||||
"docker": [
|
||||
{
|
||||
"description": "",
|
||||
|
||||
@ -1903,65 +1903,6 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "On-Premise",
|
||||
"id": "on-premise",
|
||||
"description": "Manage an on-premise installation of Nx Cloud",
|
||||
"itemList": [
|
||||
{
|
||||
"name": "Set up Nx Cloud On-Premise",
|
||||
"description": "Set up Nx Cloud on machines that you control",
|
||||
"id": "on-premise",
|
||||
"tags": ["on-premise"],
|
||||
"file": "nx-cloud/features/nx-enterprise-on-prem"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with a Single Admin",
|
||||
"id": "auth-single-admin",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-single-admin"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitHub",
|
||||
"id": "auth-github",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-github"
|
||||
},
|
||||
{
|
||||
"name": "On-Prem VM Setup",
|
||||
"id": "ami-setup",
|
||||
"file": "nx-cloud/enterprise/on-premise/ami-setup"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with GitLab",
|
||||
"id": "auth-gitlab",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-gitlab"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"id": "auth-bitbucket",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket Data Center",
|
||||
"id": "auth-bitbucket-data-center",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-bitbucket-data-center"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate via SAML",
|
||||
"id": "auth-saml",
|
||||
"file": "nx-cloud/enterprise/on-premise/auth-saml"
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"id": "advanced-config",
|
||||
"file": "nx-cloud/enterprise/on-premise/advanced-config"
|
||||
},
|
||||
{
|
||||
"name": "Custom GitHub App",
|
||||
"id": "custom-github-app",
|
||||
"file": "nx-cloud/enterprise/on-premise/custom-github-app"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Custom Distributed Task Execution",
|
||||
"id": "dte",
|
||||
|
||||
@ -1,78 +0,0 @@
|
||||
# Advanced Configuration
|
||||
|
||||
## Troubleshooting and Verbose Logging
|
||||
|
||||
To help troubleshoot installations set `verboseLogging` to `'true'`:
|
||||
|
||||
```yaml
|
||||
image:
|
||||
tag: 'latest'
|
||||
|
||||
verboseLogging: 'true'
|
||||
```
|
||||
|
||||
## Running the Mongo Database
|
||||
|
||||
Nx Cloud uses MongoDB to store its metadata. There are several common ways to run MongoDB.
|
||||
|
||||
### Using MongoDB Kubernetes Operator
|
||||
|
||||
The MongoDB team maintains the open
|
||||
source [MongoDB Kubernetes Operator](https://github.com/mongodb/mongodb-kubernetes-operator). You can use it to set up
|
||||
your own deployment of MongoDB. See [the Nx Cloud Kubernetes example](https://github.com/nrwl/nxcloud-k8s-setup) for
|
||||
more information.
|
||||
|
||||
### Using Mongo Atlas
|
||||
|
||||
[Mongo Atlas](https://mongodb.com/) is a great option for deploying MongoDB.
|
||||
|
||||
## Using External File Storage
|
||||
|
||||
By default, the on-prem version of Nx Cloud is going to start a file server and store the cached artifacts in the
|
||||
provided volume. But
|
||||
you can also configure Nx Cloud to use an external file storage. At the moment, only S3 and Azure Blob are
|
||||
supported.
|
||||
|
||||
### Using S3/Minio
|
||||
|
||||
To configure S3 as a file storage, provision the `AWS_S3_ACCESS_KEY_ID`, `AWS_S3_SECRET_ACCESS_KEY`, and `AWS_S3_BUCKET`
|
||||
env variables for the `nx-cloud-nx-api` container.
|
||||
|
||||
If you are using an accelerated bucket, et: `AWS_S3_ACCELERATED` to `true`
|
||||
|
||||
If you are using a local S3 installation (e.g., Minio), you will also need to set `AWS_S3_ENDPOINT`.
|
||||
|
||||
{% callout type="note" title="On cache item expiration time" %}
|
||||
Remember to
|
||||
set [a cache item expiration time](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-expire-general-considerations.html)
|
||||
. The default is currently 4 weeks. If you would like to keep items for longer, for example for 8 weeks, please remember
|
||||
to set the `NX_CACHE_EXPIRATION_PERIOD_IN_DAYS=56` env variable as well, so the container knows when to expire the Mongo
|
||||
cache entries as well.
|
||||
{% /callout %}
|
||||
|
||||
### Using Azure
|
||||
|
||||
To configure Azure Blob as a file storage, provision the `AZURE_CONNECTION_STRING`, `AZURE_CONTAINER` env variables for the `nx-cloud-nx-api` container.
|
||||
|
||||
To obtain the `AZURE_CONNECTION_STRING` value go to your "Storage Account" and click on "Access Keys". You will also
|
||||
need to create a container in your storage account before starting the Nx Cloud container.
|
||||
|
||||
If you use an external file storage and an external MongoDB instance, you don't have to provision the volume.
|
||||
|
||||
{% callout type="note" title="Cache expiration time" %}
|
||||
See note above about setting a cache expiration time. For Azure blob
|
||||
storage, [see this guide](https://docs.microsoft.com/en-us/azure/cdn/cdn-manage-expiration-of-blob-content).
|
||||
{% /callout %}
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,195 +0,0 @@
|
||||
# Setting up a dedicated Nx Cloud VM
|
||||
|
||||
## AWS EC2
|
||||
|
||||
1. Login to your AWS Console and select [the top image published here](https://console.aws.amazon.com/ec2/v2/home?home#Images:visibility=public-images;imageName=nx-cloud;owner=623002322076;sort=desc:imageName)
|
||||
2. Launch a new instance from that AMI
|
||||
3. Recommended instance type: `t3.2xlarge`
|
||||
4. You will need to SSH into the instance once it's created:
|
||||
- Use an existing SSH key-pair that you already have installed locally.
|
||||
- [Or create a new one and download the keys locally](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html?icmpid=docs_ec2_console#having-ec2-create-your-key-pair)
|
||||
- Then select your new SSH pair from the list
|
||||
5. Networking:
|
||||
- Allow the instance to receive HTTP and HTTPS traffic
|
||||
- Allow SSH from your current IP
|
||||
6. Leave the storage options as they are
|
||||
7. "Launch instance"
|
||||
8. Wait 10 minutes, then navigate to your instance's IP in the browser. You should see the Nx Cloud dashboard!
|
||||
|
||||
|
||||
|
||||
### Your Nx Cloud URL
|
||||
|
||||
1. At this point, your instance will have a public IP accessible from the browser.
|
||||
- You can consider this IP the URL of Nx Cloud, and proceed with the below steps and all will work fine!
|
||||
2. You might want, however, to add a Load Balancer in front of the instance, with an explicit domain (e.g. https://my-nxcloud.my-org.com).
|
||||
- This is strongly recommended because you will be able to upgrade/restart/re-configure your Nx Cloud EC2 instance while keeping the Nx Cloud URL static.
|
||||
- Create an [application load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-application-load-balancer.html)
|
||||
- You will need to create a certificate for your domain to assign to the LB
|
||||
- And you will need to target your EC2 instance from the LB
|
||||
- You should now have a permanent domain pointing to your Nx Cloud instance
|
||||
|
||||
Once you have your Nx Cloud URL proceed to the below steps!
|
||||
|
||||
### Configuring your Nx Cloud instance
|
||||
|
||||
1. Create a new `myconfiguration.yaml` file with the below contents
|
||||
|
||||
```yaml
|
||||
# This is all you need to get the baseline of your nx-cloud instance configured!
|
||||
|
||||
# Set the external URL your instance is running on. This is the URL from the previous step
|
||||
nxCloudAppURL: 'https://nx-cloud.on.my-domain.ca' # make sure no backslash is at the end
|
||||
|
||||
secret:
|
||||
# set your initial admin password for logging into the app
|
||||
adminPassword: 'correcthorsebatterystaple'
|
||||
```
|
||||
|
||||
2. Apply the configuration:
|
||||
|
||||
```bash
|
||||
scp -i ./<path-to-your-ssh-pem-file>.pem -r ./myconfiguration.yaml nx-cloud@<your-instance-ip>:~/config/user/update.yaml
|
||||
```
|
||||
|
||||
That's it! After a few minutes, you should be able to log-in with:
|
||||
|
||||
- username: `admin`
|
||||
- password: `<the-password-you-set-above>`
|
||||
|
||||
### Applying the license
|
||||
|
||||
Once you log-in, you will see an organisation has been created for you.
|
||||
|
||||
1. You can rename it or create a new organization.
|
||||
2. Navigate to your new organization's page and send us it's id
|
||||
- It should look something like this: https://your-url.com/orgs/649f240f7fb955000c1fd10b/workspaces
|
||||
3. We will then give you a License Key which you can apply on your org's billing page
|
||||
|
||||
### Connecting to your instance
|
||||
|
||||
In your Nx workspace, you can enable Nx Cloud by running:
|
||||
|
||||
```bash
|
||||
NX_CLOUD_API="https://nx-cloud.on.my-domain.ca" npx nx connect
|
||||
```
|
||||
|
||||
If it doesn't work, there might be an issue with unrecognized certificates on your instance. You can try running with:
|
||||
|
||||
```bash
|
||||
NODE_TLS_REJECT_UNAUTHORIZED=0 NX_CLOUD_API="https://nx-cloud.on.my-domain.ca" npx nx connect
|
||||
```
|
||||
|
||||
Although we have [a full guide here](https://github.com/nrwl/nx-cloud-helm/blob/main/PROXY-GUIDE.md#nxcloud-runner-proxy-issues) for dealing with self-signed certificates.
|
||||
|
||||
### Advanced configuration and auth
|
||||
|
||||
You can optionally enable authentication using your preferred SSO provider:
|
||||
|
||||
- GitHub
|
||||
- Bitbucket
|
||||
- GitLab
|
||||
- SAML (Okta, Azure AD etc.)
|
||||
- And even [Nx Agents](/ci/features/distribute-task-execution#distribute-task-execution-nx-agents)
|
||||
- Follow [the guide here](https://github.com/nrwl/nx-cloud-helm/blob/main/agents-guide/AGENTS-GUIDE.md) for setting up an Nx Agents cluster
|
||||
|
||||
```yaml
|
||||
# This is all you need to get the baseline of your nx-cloud instance configured!
|
||||
|
||||
# only use this if you'd like to use any of the newer Nx Cloud version from here: https://nx.dev/ci/reference/release-notes#docker-containers
|
||||
# global.imageTag: ''
|
||||
|
||||
# Set the external URL your instance is running on
|
||||
nxCloudAppURL: 'https://nx-cloud.on.my-domain.ca' # make sure no backslash is at the end
|
||||
|
||||
# Uncomment (along with github secrets below) to enable working with GitHub pull requests or github auth
|
||||
#github:
|
||||
# auth:
|
||||
# enabled: false
|
||||
# pr:
|
||||
# apiUrl: '' # this is only needed if you have a self-hosted github instance
|
||||
|
||||
#gitlab:
|
||||
# apiUrl: '' # this is only needed if you have a self-hosted gitlab instance
|
||||
# auth:
|
||||
# enabled: false
|
||||
|
||||
# we do not support self-hosted bitbucket instances
|
||||
#bitbucket:
|
||||
# apiUrl: '' (if using Data Center/on-prem)
|
||||
# auth:
|
||||
# enabled: false
|
||||
|
||||
#saml:
|
||||
# auth:
|
||||
# enabled: false
|
||||
|
||||
# for enabling Nx Agents
|
||||
#nxCloudWorkflows:
|
||||
# enabled: true
|
||||
# externalName: your-agents-cluster-address.com
|
||||
|
||||
# Provide plaintext values for your application to use. We will extract them,
|
||||
# store them within the application runtime, and scrub the plaintext ones from
|
||||
# the filesystem
|
||||
secret:
|
||||
# set your initial admin password for logging into the app
|
||||
# see here: https://nx.dev/ci/recipes/enterprise/on-premise/auth-single-admin
|
||||
adminPassword: 'correcthorsebatterystaple'
|
||||
|
||||
# If you want to enable GitHub Login, just provide your client id & secret, we handle the rest
|
||||
# see here: https://nx.dev/ci/recipes/enterprise/on-premise/auth-github
|
||||
githubAuthClientId: 'my_client_id'
|
||||
githubAuthClientSecret: 'my_client_secret'
|
||||
|
||||
# The same goes for GitLab authentication
|
||||
# see here: https://nx.dev/ci/recipes/enterprise/on-premise/auth-gitlab
|
||||
# gitlabAppId: 'my_gitlab_app_id'
|
||||
# gitlabAppSecret: 'my_gitlab_app_secret'
|
||||
|
||||
# Bitbucket too! If these are uncommented, BB auth is automatically enabled
|
||||
# see here: https://nx.dev/ci/recipes/enterprise/on-premise/auth-bitbucket
|
||||
# bitbucketAppId: 'bitbucket_app_id'
|
||||
# bitbucketAppSecret: 'bitbucket_app_secret'
|
||||
|
||||
# SAML auth
|
||||
# see here: https://nx.dev/ci/recipes/enterprise/on-premise/auth-saml
|
||||
# samlEntryPoint: 'your_saml_entry_point'
|
||||
# samlCert: 'saml_cert'
|
||||
```
|
||||
|
||||
### Upgrades
|
||||
|
||||
We send out emails with every new Nx Cloud release to all our Enterprise customers:
|
||||
|
||||
1. You can view your current version at the `/version` route: https://your-nx-cloud-url.com/version
|
||||
2. [And these are the latest Nx Cloud releases](/ci/reference/release-notes)
|
||||
|
||||
To upgrade to a newer version, add the below line to your `myconfiguration.yml` file:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
imageTag: '2306.01.2'
|
||||
global:
|
||||
imageTag: '2405.02.15' # set the version of nx-cloud you'd like
|
||||
helmVersion: '0.15.3' # helm version
|
||||
```
|
||||
|
||||
And apply the changes:
|
||||
|
||||
```bash
|
||||
scp -r ./myconfiguration.yaml nx-cloud@<your-instance-ip>:~/config/user/update.yaml
|
||||
```
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,36 +0,0 @@
|
||||
# BitBucket Data Center Auth
|
||||
|
||||
This page is for configuring auth via BitBucket Data Center (on-prem). If you are using BitBucket Cloud please refer to the docs [here](/ci/recipes/enterprise/on-premise/auth-bitbucket).
|
||||
|
||||
Before creating your container, your Bitbucket Data Center admin will need to create an "Application Link".
|
||||
|
||||
## Creating an Application Link
|
||||
|
||||
Your BitBucket installation admin will need to navigate to their installation settings:
|
||||
|
||||
|
||||
|
||||
Then "Application Links":
|
||||
|
||||
|
||||
|
||||
And create a new link using the settings below (make sure the callback URL is pointed to your BitBucket installation):
|
||||
|
||||
|
||||
|
||||
## Connect your Nx Cloud installation to your new app
|
||||
|
||||
It's now time to enable auth on NxCloud. Refer to the [auth guide](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md) here for instructions on configuring your Helm values file.
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,61 +0,0 @@
|
||||
# BitBucket Cloud Auth
|
||||
|
||||
This page is only for BitBucket Cloud (bitbucket.org). If you have an on-premise version of BitBucket Data Center please refer to the docs [here](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center).
|
||||
|
||||
First, you'll need to create a BitBucket "OAuth consumer" for your organisation.
|
||||
|
||||
## Creating a BitBucket OAuth consumer
|
||||
|
||||
From BitBucket, click on your profile picture and select your workspace:
|
||||
|
||||
|
||||
|
||||
Then "Settings":
|
||||
|
||||
|
||||
|
||||
Then "OAuth consumers":
|
||||
|
||||
|
||||
|
||||
And create a new consumer.
|
||||
|
||||
Give the app a name. The callback URL is the important bit. It needs to be in this form:
|
||||
|
||||
```
|
||||
[your-nx-cloud-url]/auth-callback
|
||||
|
||||
# for example
|
||||
https://my.nx-enterprise.url:8080/auth-callback
|
||||
```
|
||||
|
||||
**Important:** Ensure there is **no backslash at the end of the "Callback URL"** (i.e. it matches the above pattern)
|
||||
|
||||
|
||||
|
||||
Ensure you grant it the `account:read` and `account:email` scopes:
|
||||
|
||||
|
||||
|
||||
Save your changes.
|
||||
|
||||
Once you create, keep a note of the Key and the Secret:
|
||||
|
||||
|
||||
|
||||
## Connect your Nx Cloud installation to your new app
|
||||
|
||||
It's now time to enable auth on NxCloud. Refer to the [auth guide](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md) here for instructions on configuring your Helm values file.
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,57 +0,0 @@
|
||||
# GitHub Auth
|
||||
|
||||
First, you'll need to create a GitHub OAuth app for your organisation.
|
||||
|
||||
## Creating a GitHub OAuth app
|
||||
|
||||
From GitHub, click on your profile picture and chose "Settings":
|
||||
|
||||
|
||||
|
||||
Then "Developer settings" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
Then "OAuth Apps":
|
||||
|
||||
|
||||
|
||||
And create a new OAuth app:
|
||||
|
||||
|
||||
|
||||
Give it a name, and a homepage URL. The authorization callback is the important bit. It needs to be in this form:
|
||||
|
||||
```
|
||||
[your-nx-cloud-url]/auth-callback
|
||||
|
||||
# for example
|
||||
https://my.nx-enterprise.url:8080/auth-callback
|
||||
```
|
||||
|
||||
|
||||
|
||||
Once you create, keep a note of the Client ID:
|
||||
|
||||
|
||||
|
||||
And then generate a new client secret, and save it somewhere secure (we'll use it in a bit):
|
||||
|
||||
|
||||
|
||||
## Configure Nx Cloud Installation
|
||||
|
||||
It's now time to enable auth on NxCloud. Refer to the [auth guide](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md) here for instructions on configuring your Helm values file.
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,53 +0,0 @@
|
||||
# GitLab Auth
|
||||
|
||||
Before creating your container, you'll need to create a GitLab app for your organisation.
|
||||
|
||||
## Creating a GitLab app
|
||||
|
||||
From GitLab, click on your profile picture and chose "Preferences":
|
||||
|
||||
|
||||
|
||||
Then "Applications" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
Give the app a name. The authorization callback is the important bit. It needs to be in this form:
|
||||
|
||||
```
|
||||
[your-nx-cloud-url]/auth-callback
|
||||
|
||||
# for example
|
||||
https://my.nx-enterprise.url:8080/auth-callback
|
||||
```
|
||||
|
||||
**Important:** Ensure there is **no backslash at the end of the "Redirect URI"** (i.e. it matches the above pattern)
|
||||
|
||||
|
||||
|
||||
Ensure you grant it the "`read_user`" scope:
|
||||
|
||||
|
||||
|
||||
Click "Save application".
|
||||
|
||||
Once you create, keep a note of the Client ID and the Secret:
|
||||
|
||||
|
||||
|
||||
## Connect your Nx Cloud installation to your new app
|
||||
|
||||
It's now time to enable auth on NxCloud. Refer to the [auth guide](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md) here for instructions on configuring your Helm values file.
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,160 +0,0 @@
|
||||
# SAML Auth
|
||||
|
||||
SAML support for Nx Cloud is an addon for Nx Enterprise contracts and requires an unlock key. Please [get in touch](mailto:cloud-support@nrwl.io)
|
||||
if you are interested.
|
||||
|
||||
### Jump To
|
||||
|
||||
- [Azure AD Config](#azure-active-directory-set-up)
|
||||
- [Okta Config](#okta-setup)
|
||||
|
||||
## Azure Active Directory Set-up
|
||||
|
||||
1. Create a new enterprise app
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Choose “Create your own”:
|
||||
|
||||
|
||||
|
||||
3. Give it a name
|
||||
|
||||
|
||||
|
||||
4. Assign your users and/or groups to it:
|
||||
|
||||
|
||||
|
||||
5. Then set-up SSO
|
||||
|
||||
|
||||
|
||||
6. And choose SAML:
|
||||
|
||||
|
||||
|
||||
7. Add these configuration options
|
||||
|
||||
1. Configure the Identifier **exactly** as `nx-private-cloud`
|
||||
2. For the **Reply URL**, it should point to your Private Cloud instance URL. Make sure it ends with `/auth-callback`
|
||||
|
||||
|
||||
|
||||
8. Scroll down and manage claims:
|
||||
|
||||
|
||||
|
||||
9. The first row should be the `email` claim, click to Edit it:
|
||||
|
||||
|
||||
|
||||
10. Configure it as per below
|
||||
|
||||
1. **“Namespace”** needs to be blank
|
||||
2. **“Name:”** needs to be “email”
|
||||
3. See screenshot below. This is an important step, because Nx Cloud will expect the “email” property on each profile that logs in.
|
||||
|
||||
|
||||
|
||||
Make sure your application user profile exposes the email address under `user.mail`. This can be configured in `Users and Groups` in the Azure portal. Alternatively, you can always configure the `email` claim to use a different property under the `user` object.
|
||||
|
||||
11. Under `SAML Certificates`, click the pencil icon to edit
|
||||
|
||||
|
||||
|
||||
For **Signing Option**, select **Sign SAML response and assertion**
|
||||
|
||||
|
||||
|
||||
Then click **Save** and close the popover.
|
||||
|
||||
12. Download the certificate in **Base64**:
|
||||
|
||||
|
||||
|
||||
13. Extract the downloaded certificate value as a one-line string:
|
||||
1. `awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' azure_cert_file.cer`
|
||||
2. We’ll use this in a bit to initialize an environment variable
|
||||
14. Copy the Login URL:
|
||||
|
||||
|
||||
|
||||
15. Then add these two env vars to your Nx Cloud cluster secrets (see [Helm config](#helm-config) below):
|
||||
1. `SAML_CERT=<your-cert-string-from-above>`
|
||||
2. `SAML_ENTRY_POINT=<your-login-url-from-above>`
|
||||
|
||||
## Okta Set-up
|
||||
|
||||
1. Create a new Okta App Integration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Give it a name:
|
||||
|
||||
|
||||
|
||||
3. On the Next page, configure it as below:
|
||||
|
||||
1. The Single Sign On URL needs to point to your Nx Cloud instance URL and ends with `/auth-callback`
|
||||
2. The Audience should be `nx-private-cloud`
|
||||
|
||||
|
||||
|
||||
4. Scroll down to attribute statements and configure them as per below:
|
||||
|
||||
|
||||
|
||||
5. Click “Next”, and select the first option on the next screen.
|
||||
6. Go to the assignments tab and assign the users that can login to the Nx Cloud WebApp:
|
||||
|
||||
1. **Note:** This just gives them permission to use the Nx Cloud web app with their own workspace. Users will still need to be invited manually through the web app to your main workspace.
|
||||
|
||||
|
||||
|
||||
7. Then in the Sign-On tab scroll down:
|
||||
|
||||
|
||||
|
||||
8. Scroll down and from the list of certificates, download the one with the “Active” status:
|
||||
|
||||
|
||||
|
||||
9. Extract the downloaded certificate value as a one-line string:
|
||||
1. `awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' okta.cert`
|
||||
2. We will use this in a bit to initialize and environment variable
|
||||
10. Then view the ldP metadata:
|
||||
|
||||
|
||||
|
||||
11. Then find the row similar to the below, and copy the highlighted URL (see screenshot as well):
|
||||
|
||||
1. ```html
|
||||
<md:SingleSignOnService
|
||||
Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
|
||||
Location="https://trial-xxxxx.okta.com/app/trial-xxxxx_nxcloudtest_1/xxxxxxxxx/sso/saml"
|
||||
/>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Helm config
|
||||
|
||||
It's now time to enable auth on NxCloud. Refer to the [auth guide](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md) here for instructions on configuring your Helm values file.
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,82 +0,0 @@
|
||||
# Auth (Basic)
|
||||
|
||||
## Why do users need access?
|
||||
|
||||
While just adding an Nx Cloud access token to your monorepo gives you remote caching and distributed tasks
|
||||
execution, the Nx Cloud web app gives you analytics about tasks running in your workspace, allows devs to easily inspect
|
||||
terminal output, and works seamlessly with our GitHub integration for your Pull Requests. Here is
|
||||
a [video walkthrough of this](https://youtu.be/GT7XIwG1i5A?t=409).
|
||||
|
||||
By default, when you connect your token to a workspace on your Nx Cloud web app, all links and runs are private to only
|
||||
members of your organisation. This means that you'll either need to explicitly add members, or make your organisation
|
||||
public (which means anyone with access to your Nx Cloud instance will be able to see your runs)
|
||||
.
|
||||
|
||||
## Setting up a single admin user
|
||||
|
||||
If you just want to try out running Nx Cloud on prem and set up full membership management later, then the simplest
|
||||
option is to
|
||||
just set up a single admin user. This option might also work for you if you are okay
|
||||
with making your organisation public to anyone that has access to your
|
||||
Nx Cloud installation.
|
||||
|
||||
To do that provision the `ADMIN_PASSWORD` env variable for the `nx-cloud-aggregator` container (if you are running Nx
|
||||
Cloud as a single container, provision the `ADMIN_PASSWORD` env variable for that container). This will set up a
|
||||
default admin user for you, which you can use to manage your workspace on the Nx Cloud web app.
|
||||
|
||||
{% callout type="note" title="Preventing access loss" %}
|
||||
Even if you can make your organisation public, we still recommend setting up GitHub authentication and inviting more
|
||||
than 1 admin to your workspace, to reduce the chance of losing access to it.
|
||||
{% /callout %}
|
||||
|
||||
## Setting up third-party auth providers
|
||||
|
||||
For instructions on how to set up third-party auth providers, please refer to these guides:
|
||||
|
||||
- [GitHub Auth](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [GitLab Auth](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [BitBucket Auth](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [BitBucket Data Center Auth](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [SAML Auth](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
|
||||
## Inviting users
|
||||
|
||||
Once that's done, you can either sign in with your admin user by using the form, or
|
||||
directly via the configured third-party authentication providers by clicking the "_Sign In with configured third-party provider_" button:
|
||||
|
||||
|
||||
|
||||
You can then go to your organisation's settings and then to the members page and start inviting people based on their GitHub username.
|
||||
When you invite someone, Nx Cloud will generate a unique invite URL, which you can send to that person directly.
|
||||
|
||||
## Migrating from an admin-only set up to auth via a configured provider
|
||||
|
||||
If you already have an admin user that manages an existing Nx Cloud workspace, you can still login by using the login form, even after you set up
|
||||
GitHub auth.
|
||||
|
||||
## Finding usernames
|
||||
|
||||
To ensure only the members you trust can accept invitations to your workspace, you need to invite them via their
|
||||
GitHub/GitLab/BitBucket username, and then they need to be logged in with that username to accept the invite. Usernames
|
||||
can usually be found by clicking in the top-right corner.
|
||||
|
||||
GitLab:
|
||||
|
||||
|
||||
|
||||
GitHub:
|
||||
|
||||
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -1,119 +0,0 @@
|
||||
# Custom GitHub App
|
||||
|
||||
Before creating your container, you'll need to create a GitHub app for your organisation.
|
||||
|
||||
## Creating a GitHub OAuth app
|
||||
|
||||
From GitHub, click on your profile picture and chose "Settings":
|
||||
|
||||
|
||||
|
||||
Then "Developer settings" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
Then "GitHub Apps":
|
||||
|
||||
|
||||
|
||||
And create a new GitHub app:
|
||||
|
||||
|
||||
|
||||
Give it a name, and a homepage URL. The callback URL is the important bit. It needs to be in this form:
|
||||
|
||||
```
|
||||
[your-nx-cloud-url]/callbacks/github-user
|
||||
|
||||
# for example
|
||||
https://my.nx-enterprise.url:8080/callbacks/github-user
|
||||
```
|
||||
|
||||
Once you create the app, keep a note of the Client ID and App ID:
|
||||
|
||||
|
||||
|
||||
Then generate a new client secret, and save it somewhere secure (we'll use it in a bit):
|
||||
|
||||
|
||||
|
||||
## Configure Permissions for the GitHub App
|
||||
|
||||
The following permissions are required for Nx Cloud to work:
|
||||
|
||||
Repository permissions:
|
||||
|
||||
- `Contents: Read & Write`
|
||||
- `Pull requests: Read & Write`
|
||||
- `Checks: Read Only`
|
||||
- `Commit Statuses: Read & Write`
|
||||
- `Issues: Read & Write`
|
||||
- `Metadata: Read Only`
|
||||
|
||||
Organization permissions:
|
||||
|
||||
- `Administration: Read Only`
|
||||
- `Members: Read Only`
|
||||
|
||||
## Configure Nx Cloud Installation
|
||||
|
||||
### Using Helm:
|
||||
|
||||
```yaml
|
||||
image:
|
||||
tag: 'latest'
|
||||
|
||||
nxCloudAppURL: 'https://nx-cloud.myorg.com'
|
||||
|
||||
github:
|
||||
auth:
|
||||
enabled: true
|
||||
|
||||
secret:
|
||||
name: 'cloudsecret'
|
||||
githubAppClientId: 'NX_CLOUD_GITHUB_APP_CLIENT_ID'
|
||||
githubAppClientSecret: 'NX_CLOUD_GITHUB_APP_CLIENT_SECRET'
|
||||
githubAppId: 'NX_CLOUD_GITHUB_APP_APP_ID'
|
||||
```
|
||||
|
||||
Note that the secret must contain `NX_CLOUD_GITHUB_APP_CLIENT_ID`, `NX_CLOUD_GITHUB_APP_APP_ID`, and `NX_CLOUD_GITHUB_APP_CLIENT_SECRET` (
|
||||
see [Nx Cloud Helm Charts](https://github.com/nrwl/nx-cloud-helm) for more context).
|
||||
|
||||
### Not using Helm:
|
||||
|
||||
Provide the following env variables to the `nx-cloud-frontend` container:
|
||||
|
||||
- `NX_CLOUD_GITHUB_APP_CLIENT_ID`
|
||||
- `NX_CLOUD_GITHUB_APP_CLIENT_SECRET`
|
||||
- `NX_CLOUD_GITHUB_APP_APP_ID`
|
||||
|
||||
{% callout title="Helm Chart Environment Variables" %}
|
||||
If you are using our Helm chart, you can find all the information you need about env variables in [the Helm chart repository](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md).
|
||||
{% /callout %}
|
||||
|
||||
<!-- ## GitHub Enterprise
|
||||
|
||||
If you are running a self-hosted version of GitHub (Enterprise Server), you will need to configure one additional
|
||||
environment variable:
|
||||
|
||||
`GITHUB_API_URL=https://custom-github-instance.com`
|
||||
|
||||
This will point all auth endpoints to your GitHub server (rather the public one).
|
||||
|
||||
{% callout type="check" title="Good to know!" %}
|
||||
The above environment variable, also helps with setting up the GitHub app integration, so you can have Nx Cloud build
|
||||
stats directly on your pull request. See full set up instructions [here](/ci/recipes/source-control-integration/github).
|
||||
{% /callout %} -->
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -8,15 +8,15 @@ Before creating your container, your Bitbucket Data Center admin will need to cr
|
||||
|
||||
Your BitBucket installation admin will need to navigate to their installation settings:
|
||||
|
||||
|
||||
|
||||
|
||||
Then "Application Links":
|
||||
|
||||
|
||||
|
||||
|
||||
And create a new link using the settings below (make sure the callback URL is pointed to your BitBucket installation):
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect Your Nx Cloud Installation to Your New App
|
||||
|
||||
|
||||
@ -8,15 +8,15 @@ First, you'll need to create a BitBucket "OAuth consumer" for your organisation.
|
||||
|
||||
From BitBucket, click on your profile picture and select your workspace:
|
||||
|
||||
|
||||
|
||||
|
||||
Then "Settings":
|
||||
|
||||
|
||||
|
||||
|
||||
Then "OAuth consumers":
|
||||
|
||||
|
||||
|
||||
|
||||
And create a new consumer.
|
||||
|
||||
@ -31,17 +31,17 @@ https://my.nx-enterprise.url:8080/auth-callback
|
||||
|
||||
**Important:** Ensure there is **no backslash at the end of the "Callback URL"** (i.e. it matches the above pattern)
|
||||
|
||||
|
||||
|
||||
|
||||
Ensure you grant it the `account:read` and `account:email` scopes:
|
||||
|
||||
|
||||
|
||||
|
||||
Save your changes.
|
||||
|
||||
Once you create, keep a note of the Key and the Secret:
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect Your Nx Cloud Installation to Your BitBucket OAuth Consumer
|
||||
|
||||
|
||||
@ -6,19 +6,19 @@ First, you'll need to create a GitHub OAuth app for your organisation.
|
||||
|
||||
From GitHub, click on your profile picture and chose "Settings":
|
||||
|
||||
|
||||
|
||||
|
||||
Then "Developer settings" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
|
||||
Then "OAuth Apps":
|
||||
|
||||
|
||||
|
||||
|
||||
And create a new OAuth app:
|
||||
|
||||
|
||||
|
||||
|
||||
Give it a name, and a homepage URL. The authorization callback is the important bit. It needs to be in this form:
|
||||
|
||||
@ -29,15 +29,15 @@ Give it a name, and a homepage URL. The authorization callback is the important
|
||||
https://my.nx-enterprise.url:8080/auth-callback
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Once you create, keep a note of the Client ID:
|
||||
|
||||
|
||||
|
||||
|
||||
And then generate a new client secret, and save it somewhere secure (we'll use it in a bit):
|
||||
|
||||
|
||||
|
||||
|
||||
## Configure Nx Cloud Installation
|
||||
|
||||
|
||||
@ -6,11 +6,11 @@ Before creating your container, you'll need to create a GitLab app for your orga
|
||||
|
||||
From GitLab, click on your profile picture and chose "Preferences":
|
||||
|
||||
|
||||
|
||||
|
||||
Then "Applications" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
|
||||
Give the app a name. The authorization callback is the important bit. It needs to be in this form:
|
||||
|
||||
@ -23,17 +23,17 @@ https://my.nx-enterprise.url:8080/auth-callback
|
||||
|
||||
**Important:** Ensure there is **no backslash at the end of the "Redirect URI"** (i.e. it matches the above pattern)
|
||||
|
||||
|
||||
|
||||
|
||||
Ensure you grant it the "`read_user`" scope:
|
||||
|
||||
|
||||
|
||||
|
||||
Click "Save application".
|
||||
|
||||
Once you create, keep a note of the Client ID and the Secret:
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect Your Nx Cloud Installation to Your New App
|
||||
|
||||
|
||||
@ -12,44 +12,44 @@ if you are interested.
|
||||
|
||||
1. Create a new enterprise app
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Choose “Create your own”:
|
||||
|
||||
|
||||
|
||||
|
||||
3. Give it a name
|
||||
|
||||
|
||||
|
||||
|
||||
4. Assign your users and/or groups to it:
|
||||
|
||||
|
||||
|
||||
|
||||
5. Then set-up SSO
|
||||
|
||||
|
||||
|
||||
|
||||
6. And choose SAML:
|
||||
|
||||
|
||||
|
||||
|
||||
7. Add these configuration options
|
||||
|
||||
1. Configure the Identifier **exactly** as `nx-private-cloud`
|
||||
2. For the **Reply URL**, it should point to your Private Cloud instance URL. Make sure it ends with `/auth-callback`
|
||||
|
||||
|
||||
|
||||
|
||||
8. Scroll down and manage claims:
|
||||
|
||||
|
||||
|
||||
|
||||
9. The first row should be the `email` claim, click to Edit it:
|
||||
|
||||
|
||||
|
||||
|
||||
10. Configure it as per below
|
||||
|
||||
@ -57,30 +57,30 @@ if you are interested.
|
||||
2. **“Name:”** needs to be “email”
|
||||
3. See screenshot below. This is an important step, because Nx Cloud will expect the “email” property on each profile that logs in.
|
||||
|
||||
|
||||
|
||||
|
||||
Make sure your application user profile exposes the email address under `user.mail`. This can be configured in `Users and Groups` in the Azure portal. Alternatively, you can always configure the `email` claim to use a different property under the `user` object.
|
||||
|
||||
11. Under `SAML Certificates`, click the pencil icon to edit
|
||||
|
||||
|
||||
|
||||
|
||||
For **Signing Option**, select **Sign SAML response and assertion**
|
||||
|
||||
|
||||
|
||||
|
||||
Then click **Save** and close the popover.
|
||||
|
||||
12. Download the certificate in **Base64**:
|
||||
|
||||
|
||||
|
||||
|
||||
13. Extract the downloaded certificate value as a one-line string:
|
||||
1. `awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' azure_cert_file.cer`
|
||||
2. We’ll use this later
|
||||
14. Copy the Login URL:
|
||||
|
||||
|
||||
|
||||
|
||||
15. Save the following information to send to your DPE:
|
||||
1. `SAML_CERT=<your-cert-string-from-above>`
|
||||
@ -90,46 +90,46 @@ if you are interested.
|
||||
|
||||
1. Create a new Okta App Integration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2. Give it a name:
|
||||
|
||||
|
||||
|
||||
|
||||
3. On the Next page, configure it as below:
|
||||
|
||||
1. The Single Sign On URL needs to point to your Nx Cloud instance URL and ends with `/auth-callback`
|
||||
2. The Audience should be `nx-private-cloud`
|
||||
|
||||
|
||||
|
||||
|
||||
4. Scroll down to attribute statements and configure them as per below:
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click “Next”, and select the first option on the next screen.
|
||||
6. Go to the assignments tab and assign the users that can login to the Nx Cloud WebApp:
|
||||
|
||||
1. **Note:** This just gives them permission to use the Nx Cloud web app with their own workspace. Users will still need to be invited manually through the web app to your main workspace.
|
||||
|
||||
|
||||
|
||||
|
||||
7. Then in the Sign-On tab scroll down:
|
||||
|
||||
|
||||
|
||||
|
||||
8. Scroll down and from the list of certificates, download the one with the “Active” status:
|
||||
|
||||
|
||||
|
||||
|
||||
9. Extract the downloaded certificate value as a one-line string:
|
||||
1. `awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' okta.cert`
|
||||
2. We'll use this later
|
||||
10. Then view the ldP metadata:
|
||||
|
||||
|
||||
|
||||
|
||||
11. Then find the row similar to the below, and copy the highlighted URL (see screenshot as well):
|
||||
|
||||
@ -140,7 +140,7 @@ if you are interested.
|
||||
/>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect Your Nx Cloud Installation to Your SAML Set Up
|
||||
|
||||
|
||||
@ -6,19 +6,19 @@ Before creating your container, you'll need to create a GitHub app for your orga
|
||||
|
||||
From GitHub, click on your profile picture and chose "Settings":
|
||||
|
||||
|
||||
|
||||
|
||||
Then "Developer settings" from the left-hand menu:
|
||||
|
||||
|
||||
|
||||
|
||||
Then "GitHub Apps":
|
||||
|
||||
|
||||
|
||||
|
||||
And create a new GitHub app:
|
||||
|
||||
|
||||
|
||||
|
||||
Give it a name, and a homepage URL. The callback URL is the important bit. It needs to be in this form:
|
||||
|
||||
@ -36,11 +36,11 @@ Configure a webhook and give it a secret:
|
||||
|
||||
Once you create the app, keep a note of the Client ID and App ID:
|
||||
|
||||
|
||||
|
||||
|
||||
Then generate a new client secret, and save it somewhere secure (we'll use it in a bit):
|
||||
|
||||
|
||||
|
||||
|
||||
Finally, scroll down and download a private key:
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 194 KiB |
|
Before Width: | Height: | Size: 131 KiB After Width: | Height: | Size: 131 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 249 KiB After Width: | Height: | Size: 249 KiB |
|
Before Width: | Height: | Size: 198 KiB After Width: | Height: | Size: 198 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 167 KiB After Width: | Height: | Size: 167 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 198 KiB After Width: | Height: | Size: 198 KiB |
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 181 KiB After Width: | Height: | Size: 181 KiB |
|
Before Width: | Height: | Size: 298 KiB After Width: | Height: | Size: 298 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 120 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 157 KiB After Width: | Height: | Size: 157 KiB |
|
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 143 KiB |
|
Before Width: | Height: | Size: 175 KiB After Width: | Height: | Size: 175 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 287 KiB After Width: | Height: | Size: 287 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 131 KiB After Width: | Height: | Size: 131 KiB |
|
Before Width: | Height: | Size: 137 KiB After Width: | Height: | Size: 137 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 166 KiB After Width: | Height: | Size: 166 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 107 KiB After Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 155 KiB After Width: | Height: | Size: 155 KiB |
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 113 KiB |
@ -1,70 +0,0 @@
|
||||
# Running Nx Cloud Enterprise
|
||||
|
||||
We offer multiple ways of running Nx Cloud for our Enterprise customers. The below options are listed in recommended order, from easiest to most complex in terms of set-up and maintenance for your team. Please carefully consider your organization's requirements and level of infrastructure expertise before deciding on a deployment option.
|
||||
|
||||
{% call-to-action title="Get in Touch" icon="nxcloud" description="Get the package that best fits your needs" url="/enterprise" /%}
|
||||
|
||||
## Managed Setup
|
||||
|
||||
### Multi-tenant
|
||||
|
||||
The quickest and easiest way to start using Nx Cloud is by utilizing our pre-existing secure, multi-tenant managed clusters:
|
||||
|
||||
- [https://nx.app/](https://nx.app/)
|
||||
- Enterprise customers can contact their developer productivity engineer (DPE) to configure the EU hosted version of Nx Cloud.
|
||||
|
||||
You get the **same level of security**, **dedicated support**, and **predictable seat-based pricing** as all our other hosting options. But you won't have to manage the instance yourself.
|
||||
|
||||
We also offer an uptime SLA guarantee of 99.98% for our Enterprise customers, SOC certificates on request, and we're happy to meet with your security teams if they have questions, or fill in security questionnaires. We also maintain a [Status Page here](https://status.nx.app/).
|
||||
|
||||
To start with this option, it's as easy as creating an account on [nx.app](https://cloud.nx.app) and connecting your repository.
|
||||
|
||||
### Single-tenant instance
|
||||
|
||||
If you have very specific requirements, then we can also offer to host Nx Cloud for you in an isolated/single-tenant cluster.
|
||||
|
||||
We'll be able to discuss specific requirements such as:
|
||||
|
||||
- SAML/SSO
|
||||
- Specific regions you want your data to be in
|
||||
- Network isolation / dedicated VPCs
|
||||
- Dedicated instances
|
||||
- Different storage encryption than what is available on our multi-tenant instances
|
||||
- Custom storage replication / redundancy requirements
|
||||
- Custom Node types for Nx agents
|
||||
- Static IPs (if you need to open up connections in your corporate network)
|
||||
- VPC peering on GCloud or AWS Private Link
|
||||
|
||||
This would be a "best of both worlds" option, as it would free you up from managing the instance yourself, but you will get to define specific parameters of how it should run.
|
||||
Your data and the Nx Cloud will run in complete isolation and will only serve your company. There will be no external API calls to any services outside of the clusters we set-up for you.
|
||||
|
||||
Once you let us know you'd like this option, depending on the agreed requirements, it might take a few days to get it set up.
|
||||
|
||||
## On-prem, managed by your organization
|
||||
|
||||
If you would like to host Nx Cloud yourself, within your organization's infrastructure, we currently offer two options. Please reach out to your DPE first to discuss them in detail. We can then help suggest a recommended route.
|
||||
|
||||
### Self-contained VM
|
||||
|
||||
The quickest one is setting it up as a ["self-contained VM"](/ci/recipes/enterprise/on-premise/ami-setup) on Amazon EC2.
|
||||
|
||||
### Multi-node setup with Kubernetes
|
||||
|
||||
We also offer a multi-node Kubernetes setup, that is deployed via Helm. You can head over to our [Helm repository](https://github.com/nrwl/nx-cloud-helm/) to explore this option.
|
||||
|
||||
## Resources
|
||||
|
||||
- [Integration with your source control provider](/ci/recipes/source-control-integration)
|
||||
|
||||
## On Premise Docs
|
||||
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
@ -91,7 +91,7 @@ We now have full support for BitBucket Data Center (self-hosted):
|
||||
- VCS integration for posting comments with live updates about your CI runs
|
||||
- full agents integration
|
||||
- more info about each one of your commits on the NxCloud web app
|
||||
- you can even [set-up auth with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center#bitbucket-data-center-auth)
|
||||
- you can even [set-up auth with BitBucket Data Center](/ci/recipes/enterprise/single-tenant/auth-bitbucket-data-center#bitbucket-data-center-auth)
|
||||
|
||||
##### Misc
|
||||
|
||||
@ -109,7 +109,7 @@ If you are using DTE, you will now need to pass the `--distribute-on="manual"` f
|
||||
|
||||
A few months ago, we introduced a new feature to our managed SASS NxCloud product: easy membership management via GitHub. If you create a new workspace on [https://cloud.nx.app/](https://cloud.nx.app/) right now you will be guided through how to connect it to your GitHub repository. Now everyone that has access to your GitHub repository will also get access to your NxCloud workspace. If anyone loses access to GitHub (maybe they leave the company), they will also lose access to NxCloud. This makes membership management easy and straightforward, as you don't have to manually invite users anymore. Of course, setting up this connection also gives you NxCloud run status updates directly on your PRs - a feature we've had for a long time.
|
||||
|
||||
This feature has now been release for on-prem set-ups as well. To benefit from it, you'll need to create your own Github App with permissions to access your repository. Your on-prem NxCloud instance will then use this app to pull membership info from Github and check user permissions. You can find [the full setup instructions here](/ci/recipes/enterprise/on-premise/custom-github-app).
|
||||
This feature has now been release for on-prem set-ups as well. To benefit from it, you'll need to create your own Github App with permissions to access your repository. Your on-prem NxCloud instance will then use this app to pull membership info from Github and check user permissions. You can find [the full setup instructions here](/ci/recipes/enterprise/single-tenant/custom-github-app).
|
||||
|
||||
##### DTE v2 enabled by default
|
||||
|
||||
|
||||
@ -306,17 +306,6 @@
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/single-tenant/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/single-tenant/auth-saml)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/single-tenant/custom-github-app)
|
||||
- [On-Premise](/ci/recipes/enterprise/on-premise)
|
||||
- [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
|
||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||
- [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
|
||||
- [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
|
||||
- [Authenticate with GitLab](/ci/recipes/enterprise/on-premise/auth-gitlab)
|
||||
- [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket)
|
||||
- [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center)
|
||||
- [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml)
|
||||
- [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config)
|
||||
- [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app)
|
||||
- [Custom Distributed Task Execution](/ci/recipes/enterprise/dte)
|
||||
- [GitHub Actions Custom DTE](/ci/recipes/enterprise/dte/github-dte)
|
||||
- [Circle CI Custom DTE](/ci/recipes/enterprise/dte/circle-ci-dte)
|
||||
|
||||
@ -30,42 +30,6 @@ const pages: Array<{ title: string; path: string }> = [
|
||||
title: 'Enable End to End Encryption',
|
||||
path: '/ci/recipes/security/encryption',
|
||||
},
|
||||
{
|
||||
title: 'Running Nx Cloud Enterprise',
|
||||
path: '/ci/recipes/enterprise/on-premise/on-premise',
|
||||
},
|
||||
{
|
||||
title: 'Auth (Basic)',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-single-admin',
|
||||
},
|
||||
{
|
||||
title: 'GitHub Auth',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-github',
|
||||
},
|
||||
{
|
||||
title: 'GitLab Auth',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-gitlab',
|
||||
},
|
||||
{
|
||||
title: 'Setting up a dedicated Nx Cloud VM',
|
||||
path: '/ci/recipes/enterprise/on-premise/ami-setup',
|
||||
},
|
||||
{
|
||||
title: 'BitBucket Cloud Auth',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-bitbucket',
|
||||
},
|
||||
{
|
||||
title: 'BitBucket Data Center Auth',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center',
|
||||
},
|
||||
{
|
||||
title: 'SAML Auth',
|
||||
path: '/ci/recipes/enterprise/on-premise/auth-saml',
|
||||
},
|
||||
{
|
||||
title: 'Advanced Configuration',
|
||||
path: '/ci/recipes/enterprise/on-premise/advanced-config',
|
||||
},
|
||||
{
|
||||
title: 'Configuring the Cloud Runner / Nx CLI',
|
||||
path: '/ci/reference/config',
|
||||
|
||||
@ -429,9 +429,11 @@ const nxCloudUrls = {
|
||||
'/core-features/distribute-task-execution':
|
||||
'/ci/features/distribute-task-execution',
|
||||
'/concepts/affected': '/ci/features/affected',
|
||||
'/nx-cloud/private-cloud': '/ci/recipes/enterprise/on-premise',
|
||||
'/nx-cloud/private-cloud': '/ci/recipes/enterprise/single-tenant',
|
||||
'/nx-cloud/private-cloud/get-started':
|
||||
'/ci/recipes/enterprise/on-premise/on-premise',
|
||||
'/ci/recipes/enterprise/single-tenant/overview',
|
||||
'/ci/recipes/enterprise/on-premise/on-premise':
|
||||
'/ci/recipes/enterprise/single-tenant/overview',
|
||||
'/ci/features/on-premise': '/ci/recipes/enterprise/on-premise/on-premise',
|
||||
'/nx-cloud/private-cloud/auth-single-admin':
|
||||
'/ci/recipes/enterprise/on-premise/auth-single-admin',
|
||||
@ -449,19 +451,38 @@ const nxCloudUrls = {
|
||||
'/ci/recipes/enterprise/on-premise/auth-saml',
|
||||
'/nx-cloud/private-cloud/advanced-config':
|
||||
'/ci/recipes/enterprise/on-premise/advanced-config',
|
||||
'/ci/recipes/on-premise': '/ci/recipes/enterprise/on-premise',
|
||||
'/ci/recipes/on-premise': '/ci/recipes/enterprise/single-tenant',
|
||||
'/ci/recipes/enterprise/on-premise': '/ci/recipes/enterprise/single-tenant',
|
||||
'/ci/recipes/on-premise/auth-single-admin':
|
||||
'/ci/recipes/enterprise/on-premise/auth-single-admin',
|
||||
'/ci/recipes/enterprise/on-premise/auth-single-admin':
|
||||
'/ci/recipes/enterprise/single-tenant/overview',
|
||||
'/ci/recipes/enterprise/on-premise/ami-setup':
|
||||
'/ci/recipes/enterprise/single-tenant/overview',
|
||||
'/ci/recipes/enterprise/on-premise/advanced-config':
|
||||
'/ci/recipes/enterprise/single-tenant/overview',
|
||||
'/ci/recipes/on-premise/auth-github':
|
||||
'/ci/recipes/enterprise/on-premise/auth-github',
|
||||
'/ci/recipes/enterprise/single-tenant/auth-github',
|
||||
'/ci/recipes/enterprise/on-premise/auth-github':
|
||||
'/ci/recipes/enterprise/single-tenant/auth-github',
|
||||
'/ci/recipes/on-premise/ami-setup':
|
||||
'/ci/recipes/enterprise/on-premise/ami-setup',
|
||||
'/ci/recipes/on-premise/auth-gitlab':
|
||||
'/ci/recipes/enterprise/on-premise/auth-gitlab',
|
||||
'/ci/recipes/enterprise/single-tenant/auth-gitlab',
|
||||
'/ci/recipes/enterprise/on-premise/auth-gitlab':
|
||||
'/ci/recipes/enterprise/single-tenant/auth-gitlab',
|
||||
'/ci/recipes/on-premise/auth-bitbucket':
|
||||
'/ci/recipes/enterprise/on-premise/auth-bitbucket',
|
||||
'/ci/recipes/enterprise/single-tenant/auth-bitbucket',
|
||||
'/ci/recipes/enterprise/on-premise/auth-bitbucket':
|
||||
'/ci/recipes/enterprise/single-tenant/auth-bitbucket',
|
||||
'/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center':
|
||||
'/ci/recipes/enterprise/single-tenant/auth-bitbucket-data-center',
|
||||
'/ci/recipes/on-premise/auth-saml':
|
||||
'/ci/recipes/enterprise/on-premise/auth-saml',
|
||||
'/ci/recipes/enterprise/single-tenant/auth-saml',
|
||||
'/ci/recipes/enterprise/on-premise/auth-saml':
|
||||
'/ci/recipes/enterprise/single-tenant/auth-saml',
|
||||
'/ci/recipes/enterprise/on-premise/custom-github-app':
|
||||
'/ci/recipes/enterprise/single-tenant/custom-github-app',
|
||||
'/ci/recipes/on-premise/auth-saml-managed':
|
||||
'/ci/recipes/enterprise/on-premise/auth-saml',
|
||||
'/ci/recipes/enterprise/on-premise/auth-saml-managed':
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user