diff --git a/4.1.1/check.md b/4.1.1/check.md new file mode 100644 index 0000000..212ec03 --- /dev/null +++ b/4.1.1/check.md @@ -0,0 +1,45 @@ +--- +title: check +parent: v4.1.1 +--- + +# check + +Tests environment configuration is acceptable for CluedIn. +{: .fs-6 .fw-300 } + +Performs a series of checks against the host machine for required services (e.g. docker), +performance concerns (e.g. available memory), and validates environment configuration +(e.g. port availability). + +## Syntax + +``` +check [[-Env] ] +``` + +```powershell +> .\cluedin.ps1 check + ++----------------------------+ +| CluedIn - Pre-Flight Check | ++----------------------------+ +Installed Applications +[1/3] ✅ » PowerShell : 7.1.1 / Core +[2/3] ✅ » Docker : 20.10.7 / linux +[3/3] ✅ » Docker Compose : 1.29.2 +Available Ports +[1/23] ✅ » CluedIn UI : 127.0.0.1.nip.io:9080 +[2/23] ✅ » CluedIn API : 127.0.0.1.nip.io:9000 +[3/23] ✅ » CluedIn Auth : 127.0.0.1.nip.io:9001 +[4/23] ✅ » CluedIn Jobs : 127.0.0.1.nip.io:9003 +[5/23] ✅ » CluedIn WebHooks : 127.0.0.1.nip.io:9006 +[6/23] ✅ » CluedIn Public : 127.0.0.1.nip.io:9007 +#... +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. + + diff --git a/4.1.1/createorg.md b/4.1.1/createorg.md new file mode 100644 index 0000000..6d26fda --- /dev/null +++ b/4.1.1/createorg.md @@ -0,0 +1,40 @@ +--- +title: createorg +parent: v4.1.1 +--- + +# createorg + +Creates a new organization in CluedIn. +{: .fs-6 .fw-300 } + +When creating a new organization an organization admin account is also created. +The associated login details are returned. + +## Syntax + +``` +createorg [[-Env] ] -Name [-Email ] [-Pass ] [-AllowEmailSignup] +``` + +```powershell +> .\cluedin.ps1 createorg -Name example + ++-------------------------------+ +| CluedIn - Create Organization | ++-------------------------------+ + +#... +Email: admin@example.com +Password: P@ssword!123 +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Name | String | true | | The name of the organization to created. +| Email | String | false | "admin@${Name}.com" | The email/username of the organization admin. +| Pass | String | false | P@ssword!123 | The password of the organization admin. +| AllowEmailSignup | Flag | false | False | If set to true, will allow direct email sign up for future users
using an email that matches the organization admins email domain. + + diff --git a/4.1.1/data.md b/4.1.1/data.md new file mode 100644 index 0000000..6965386 --- /dev/null +++ b/4.1.1/data.md @@ -0,0 +1,62 @@ +--- +title: data +parent: v4.1.1 +--- + +# data + +Identifies and clears data for an instance of CluedIn. +{: .fs-6 .fw-300 } + +When an environment is started, one or more services may store data +outside of the container so that it can be used for future scenarios. +This command enables identification and removal of persisted data. + +## Get Details + +``` +data [[-Env] ] +``` + +Displays information on the persisted data for an environment. +e.g +``` +> .\cluedin.ps1 data +Name Size Items +---- ---- ----- +elasticsearch 0.49 MB 56 +neo4j 0.91 MB 43 +sqlserver 240.06 MB 32 +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. + +## Clear All + +``` +data [[-Env] ] -CleanAll +``` + +Forces all persisted data for all services to be wiped from disk. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| CleanAll | Flag | true | False | Clears all data for all services. + +## Clear Service(s) + +``` +data [[-Env] ] -Clean +``` + +Removes the persisted data for one or more services. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Clean | String[] | true | | Specify one or more service names who's data is to be cleared. + + diff --git a/4.1.1/down.md b/4.1.1/down.md new file mode 100644 index 0000000..f6a0b36 --- /dev/null +++ b/4.1.1/down.md @@ -0,0 +1,27 @@ +--- +title: down +parent: v4.1.1 +--- + +# down + +Terminates a running instance of CluedIn. +{: .fs-6 .fw-300 } + +Running `down` will stop all containers and persisted data. +The images themselves will not be removed, so this command +can be used to effectively clear out an instance, ready to +run again from a clean state. + +## Syntax + +``` +down [[-Env] ] [-KeepData] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| KeepData | Flag | false | False | If set, data for services will be retained for future use. + + diff --git a/4.1.1/env.md b/4.1.1/env.md new file mode 100644 index 0000000..219d3c8 --- /dev/null +++ b/4.1.1/env.md @@ -0,0 +1,98 @@ +--- +title: env +parent: v4.1.1 +--- + +# env + +Management of CluedIn environments. +{: .fs-6 .fw-300 } + +Environments allow alternative configurations of CluedIn to be managed +at the same time. + +Using environments, you can configure different versions of CluedIn, +configure different packages, validate different imports of data, and more. + +## Get + +``` +env [[-Name] ] [-Get] +``` + +Displays current variables for an environment. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| Get | Flag | false | False | When set, displays information about the environment. + +## Tag Override + +``` +env [[-Name] ] -TagOverride +``` + +Enables overriding specific services with their own version of CluedIn. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.
The names or services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` + +## Remove + +``` +env [[-Name] ] -Remove +``` + +Removes an environment completely. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| Remove | Flag | true | False | When set, fully removes the environment from disk. + +## Unset + +``` +env [[-Name] ] -Unset +``` + +Removes the current setting for a variable. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| Unset | String[] | true | | The names of variables to be unset in the environment. + +## Tag + +``` +env [[-Name] ] -Tag [-TagOverride ] +``` + +Set the default tag to be used for all CluedIn services. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| Tag | String | true | [string]::Empty | The CluedIn version tag to use for all services. +| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.
The names or services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` + +## Set + +``` +env [[-Name] ] -Set [-Tag ] [-TagOverride ] +``` + +Set one or more variables within an environment. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Name | String | false | default | The environment in which CluedIn will run. +| Set | String[] | true | | Variables to set within the environment.
e.g. `-set CLUEDIN_SERVER_LOCALPORT=9988,CLUEDIN_SQLSERVER_LOCALPORT=9533` +| Tag | String | true | [string]::Empty | The CluedIn version tag to use for all services. +| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.
The names or services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` + + diff --git a/4.1.1/index.md b/4.1.1/index.md new file mode 100644 index 0000000..7de7a09 --- /dev/null +++ b/4.1.1/index.md @@ -0,0 +1,11 @@ +--- +has_toc: False +title: v4.1.1 +has_children: True +--- + +# Release Notes - v4.1.1 + +## Features +## Fixes + diff --git a/4.1.1/open.md b/4.1.1/open.md new file mode 100644 index 0000000..8b2794a --- /dev/null +++ b/4.1.1/open.md @@ -0,0 +1,25 @@ +--- +title: open +parent: v4.1.1 +--- + +# open + +Opens CluedIn. +{: .fs-6 .fw-300 } + +Starts CluedIn in the default browser using the environments configured +host/port information. + +## Syntax + +``` +open [[-Env] ] [-Org ] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Org | String | false | app | Open the sign in page for the specified organization. + + diff --git a/4.1.1/packages.md b/4.1.1/packages.md new file mode 100644 index 0000000..a1c837f --- /dev/null +++ b/4.1.1/packages.md @@ -0,0 +1,125 @@ +--- +title: packages +parent: v4.1.1 +--- + +# packages + +Manage packages for a CluedIn instance. +{: .fs-6 .fw-300 } + +The packages command controls the configuration and management of +nuget packages to extend and enhance a CluedIn implementation. +Packages can be added from public or private feeds and restored +before starting an environment. + +Any changes to the package or feeds list, will require a `clean` and +`restore` to ensure the correct packages are available to the environment. + +## List + +``` +packages [[-Env] ] [-List] +``` + +Displays the packages and versions that would be restored. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| List | Flag | false | False | When set, will display the currently configured package details. + +## Add + +``` +packages [[-Env] ] -Add [-Version ] +``` + +Adds a package to the package list. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Add | String | true | | The name of a package to be added to the environment. +| Version | String | false | [string]::empty | The version of the package to be added.
If not provided, the latest release version will be used.
May be configured with '-*'. This will cause the latest pre-release
of to be restored, or will be restored if it has been released. + +## Remove + +``` +packages [[-Env] ] -Remove +``` + +Removes a package from the package list. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Remove | String | true | | The name of a package to remove from the environment. + +## Add Feed + +``` +packages [[-Env] ] -AddFeed -Uri [-User ] [-Pass ] [-Tag ] [-Pull] +``` + +Adds a new package feed to the packages sources. +The feed can be a public url or a local file path. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| AddFeed | String | true | | The name of a feed to be added to the feeds list. +| Uri | String | true | | The uri of the feed to be added. +| User | String | false | | The username for a feed if the feed requires authentication. +| Pass | String | false | | The password for a feed if the feed requires authentication. +| Tag | String | false | [string]::Empty | When set, will use a specific version of the nuget-installer image. +| Pull | Flag | false | False | When set, will force a docker pull of the nuget-installer image. + +## Remove Feed + +``` +packages [[-Env] ] -RemoveFeed [-Tag ] [-Pull] +``` + +Removes a feed from the package sources. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| RemoveFeed | String | true | | The name of a feed to be removed from the feeds list. +| Tag | String | false | [string]::Empty | When set, will use a specific version of the nuget-installer image. +| Pull | Flag | false | False | When set, will force a docker pull of the nuget-installer image. + +## Clean + +``` +packages [[-Env] ] -Clean +``` + +Removes all restored packages from disk. +Configured package versions and feeds are not removed. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Clean | Flag | true | False | When set, will remove all restored packages for the environment. + +## Restore + +``` +packages [[-Env] ] -Restore [-ClearCache] [-Tag ] [-Pull] +``` + +Using the configured package sources and package versions, +downloads and collates package libraries to disk so that +the CluedIn environment can install them during startup. + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Restore | Flag | true | False | When set, will restore packages for the environment. +| ClearCache | Flag | false | False | When set, will clear caches. Should be used when restoring local packages
where the build number has not changed. +| Tag | String | false | [string]::Empty | When set, will use a specific version of the nuget-installer image. +| Pull | Flag | false | False | When set, will force a docker pull of the nuget-installer image. + + diff --git a/4.1.1/pull.md b/4.1.1/pull.md new file mode 100644 index 0000000..549695e --- /dev/null +++ b/4.1.1/pull.md @@ -0,0 +1,27 @@ +--- +title: pull +parent: v4.1.1 +--- + +# pull + +Pulls the latest container images from the container registry. +{: .fs-6 .fw-300 } + +Docker images may be refreshed using the same tag. Run this command +to ensure you always have the most up-to-date version image for +the specified tag. + +## Syntax + +``` +pull [[-Env] ] [-Tag ] [-TagOverride ] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Tag | String | false | | The CluedIn version tag to use for all services.
Defaults to the setting in the environment. +| TagOverride | String[] | false | @() | The CluedIn version tag to use for specific services.
The names or services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta`
Defaults to the settings in the environment. + + diff --git a/4.1.1/start.md b/4.1.1/start.md new file mode 100644 index 0000000..91a7034 --- /dev/null +++ b/4.1.1/start.md @@ -0,0 +1,27 @@ +--- +title: start +parent: v4.1.1 +--- + +# start + +Starts a previously stopped instance of CluedIn. +{: .fs-6 .fw-300 } + +Calling start will restart an instance of CluedIn +but will not create the containers if they do not exist. +Use `up` to ensure containers are created. + +## Syntax + +``` +start [[-Env] ] [-Tag ] [-TagOverride ] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Tag | String | false | | The CluedIn version tag to use for all services.
Defaults to the setting in the environment. +| TagOverride | String[] | false | @() | The CluedIn version tag to use for specific services.
The names or services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta`
Defaults to the settings in the environment. + + diff --git a/4.1.1/status.md b/4.1.1/status.md new file mode 100644 index 0000000..40bf9c0 --- /dev/null +++ b/4.1.1/status.md @@ -0,0 +1,77 @@ +--- +title: status +parent: v4.1.1 +--- + +# status + +Checks the health status of a running CluedIn instance. +{: .fs-6 .fw-300 } + +Prints status of the CluedIn Docker containers. +Additionally, requests the health status of a running CluedIn instance, +reporting back a red/green status for each hosted web service and +each data persistance service. + +## Syntax + +``` +status [[-Env] ] [-Brief] +``` + +```powershell +> .\cluedin.ps1 status + ++------------------------+ +| CluedIn - Status Check | ++------------------------+ +Docker containers status + + Name Command State Ports +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +cluedin_325_61ef0f49_annotation_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:9010->8888/tcp,:::9010->8888/tcp +cluedin_325_61ef0f49_clean_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:9009->8888/tcp,:::9009->8888/tcp +cluedin_325_61ef0f49_datasource_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:9011->8888/tcp,:::9011->8888/tcp +cluedin_325_61ef0f49_documentation_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:9021->8888/tcp,:::9021->8888/tcp +cluedin_325_61ef0f49_elasticsearch_1 /tini -- /usr/local/bin/do ... Up 0.0.0.0:9200->9200/tcp,:::9200->9200/tcp, 0.0.0.0:9300->9300/tcp,:::9300->9300/tcp +cluedin_325_61ef0f49_gql_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:8888->8888/tcp,:::8888->8888/tcp +cluedin_325_61ef0f49_grafana_1 /run.sh Up 0.0.0.0:3030->3000/tcp,:::3030->3000/tcp +cluedin_325_61ef0f49_neo4j_1 /sbin/tini -g -- /entrypoi ... Up 7473/tcp, 0.0.0.0:7474->7474/tcp,:::7474->7474/tcp, 0.0.0.0:7687->7687/tcp,:::7687->7687/tcp +cluedin_325_61ef0f49_openrefine_1 /app/refine Up 0.0.0.0:3333->3333/tcp,:::3333->3333/tcp +cluedin_325_61ef0f49_prometheus_1 /bin/prometheus --web.enab ... Up 0.0.0.0:9090->9090/tcp,:::9090->9090/tcp +cluedin_325_61ef0f49_rabbitmq_1 docker-entrypoint.sh rabbi ... Up 15671/tcp, 0.0.0.0:15672->15672/tcp,:::15672->15672/tcp, 25672/tcp, 4369/tcp, 5671/tcp, 0.0.0.0:5672->5672/tcp,:::5672->5672/tcp +cluedin_325_61ef0f49_redis_1 docker-entrypoint.sh redis ... Up 0.0.0.0:6379->6379/tcp,:::6379->6379/tcp +cluedin_325_61ef0f49_seq_1 /run.sh Up 0.0.0.0:5341->5341/tcp,:::5341->5341/tcp, 0.0.0.0:3200->80/tcp,:::3200->80/tcp +cluedin_325_61ef0f49_server_1 sh ./boot.sh Up 0.0.0.0:9000->9000/tcp,:::9000->9000/tcp, 0.0.0.0:9001->9001/tcp,:::9001->9001/tcp, 0.0.0.0:9003->9003/tcp,:::9003->9003/tcp, + 0.0.0.0:9006->9006/tcp,:::9006->9006/tcp, 0.0.0.0:9007->9007/tcp,:::9007->9007/tcp, 0.0.0.0:9013->9013/tcp,:::9013->9013/tcp +cluedin_325_61ef0f49_sqlserver_1 sh -c /init/init.sh Up 0.0.0.0:1433->1433/tcp,:::1433->1433/tcp +cluedin_325_61ef0f49_submitter_1 dotnet CluedIn.MicroServic ... Up 0.0.0.0:9012->8888/tcp,:::9012->8888/tcp +cluedin_325_61ef0f49_ui_1 /docker-entrypoint.sh /ent ... Up 80/tcp, 0.0.0.0:9080->8080/tcp,:::9080->8080/tcp + +Running CluedIn instance status + +Can Connect +[1/1] ✅ » Is Up : http://127.0.0.1.nip.io:9000/status +DataShards +[1/6] ✅ » Blob +[2/6] ✅ » Configuration +[3/6] ✅ » Data +[4/6] ✅ » Search +[5/6] ✅ » Graph +[6/6] ✅ » Metrics +Components +[1/6] ✅ » Api +[2/6] ✅ » Authentication +[3/6] ✅ » Crawling +[4/6] ✅ » Scheduling +[5/6] ✅ » ServiceBus +[6/6] ✅ » System +#... +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn is running. +| Brief | Flag | false | False | Return basic status information only + + diff --git a/4.1.1/stop.md b/4.1.1/stop.md new file mode 100644 index 0000000..010789e --- /dev/null +++ b/4.1.1/stop.md @@ -0,0 +1,24 @@ +--- +title: stop +parent: v4.1.1 +--- + +# stop + +Stops an instance of CluedIn. +{: .fs-6 .fw-300 } + +Stopping containers allows them to be started faster in +the future as the container does not need to be re-created. + +## Syntax + +``` +stop [[-Env] ] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. + + diff --git a/4.1.1/up.md b/4.1.1/up.md new file mode 100644 index 0000000..828add1 --- /dev/null +++ b/4.1.1/up.md @@ -0,0 +1,30 @@ +--- +title: up +parent: v4.1.1 +--- + +# up + +Creates and starts an instance of CluedIn. +{: .fs-6 .fw-300 } + +If the containers for CluedIn do not exist, they will +be created and started. If they do exist, they will +be restarted. + +## Syntax + +``` +up [[-Env] ] [-Tag ] [-TagOverride ] [-Disable ] [-Pull] [-DisableData] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Env | String | false | default | The environment in which CluedIn will run. +| Tag | String | false | | The CluedIn version tag to use for all services.
Defaults to the setting in the environment. +| TagOverride | String[] | false | @() | The CluedIn version tag to use for specific services.
The names of services match those reported by docker when starting CluedIn
e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta`
Defaults to the settings in the environment. +| Disable | String[] | false | | The services to disable during startup. This allows parts
of CluedIn to be hosted in docker, with other services hosted
locally or on a different network.
The names of services match those reported by docker when starting CluedIn
e.g. `-disabler server,sqlserver` +| Pull | Flag | false | False | When set, the latest versions of images will be pulled first. +| DisableData | Flag | false | False | When set, the data folder will not be used for reading/writing data.
All data will be persisted directly to the running docker image. + + diff --git a/4.1.1/version.md b/4.1.1/version.md new file mode 100644 index 0000000..dd26029 --- /dev/null +++ b/4.1.1/version.md @@ -0,0 +1,25 @@ +--- +title: version +parent: v4.1.1 +--- + +# version + +Get version information for Home. +{: .fs-6 .fw-300 } + +Verify the version of CluedIn Home that you are running. +This information can be used to validate the version and +commit you have checked out. + +## Syntax + +``` +version [-Detailed] +``` + +| Parameter | Type | Required | Default Value | Description | +| --------- | ---- | -------- | ------------- | ----------- | +| Detailed | Flag | false | False | + +