Skip to content

Commit dd22b8c

Browse files
authored
Merge pull request #3392 from aleksandrychev/ENT-6532
ENT-6532: Added VCS project subdirectory to API and Hub management docs
2 parents 6a1913f + edf152d commit dd22b8c

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

api/enterprise-api-ref/vcs-settings.markdown

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ curl -k --user <username>:<password> \
3434
"data": {
3535
"GIT_URL": "https://github.com/cfengine/masterfiles.git",
3636
"GIT_REFSPEC": "master",
37+
"PROJECT_SUBDIRECTORY": "path/to/policies",
3738
"GIT_USERNAME": "username",
3839
"GIT_PASSWORD": "passwordOrToken",
3940
"GIT_WORKING_BRANCH": "CF_WORKING_BRANCH",
@@ -58,6 +59,9 @@ curl -k --user <username>:<password> \
5859
Git repository URL `Emp: https://github.com/cfengine/masterfiles.git`. Required parameter.
5960
* **gitRefspec** *(string)*
6061
The Git refspec to checkout. It can be a branch name, a tag name, a commit hash or a partial hash. Required parameter.
62+
* **projectSubdirectory** *(string)*
63+
Subdirectory inside Git repository where the project is located.
64+
Optional parameter.
6165
* **gitUsername** *(string)*
6266
Git username for authentication, not needed for public repositories.
6367
* **gitPassword** *(string)*
@@ -75,6 +79,7 @@ curl -k --user <username>:<password> \
7579
-d '{
7680
"gitServer":"https://github.com/cfengine/masterfiles.git",
7781
"gitRefspec":"master",
82+
"projectSubdirectory":"",
7883
"gitUsername":"gituser",
7984
"gitPassword":"passwordOrToken",
8085
"gitPrivateKey" "Private key raw content"
@@ -88,6 +93,7 @@ curl -k --user <username>:<password> \
8893
{
8994
"gitServer": "https://github.com/cfengine/masterfiles.git",
9095
"gitRefspec": "master",
96+
"projectSubdirectory": "",
9197
"gitUsername": "gituser",
9298
"gitPassword": "passwordOrToken",
9399
"gitPrivateKey": "/opt/cfengine/userworkdir/admin/.ssh/id_rsa.pvt"
@@ -97,3 +103,4 @@ curl -k --user <username>:<password> \
97103
## History
98104

99105
* `vscType` parameter added in 3.19.0, 3.18.1
106+
* `projectSubdirectory` parameter added in 3.21.7, 3.24.2, 3.26.0

web-ui/hub_administration/policy-deployment.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ The last option, a read-only login, is the best approach as it removes the possi
5454

5555
To configure the upstream repository. You must provide the uri and a refspec (branch name usually).
5656
Credentials can be specified in several ways as mentioned above so pick your choice above and enter in only the needed information in the form.
57+
If your CFEngine policies are not located in the repository root, you can specify the path in the "Project subdirectory" text input field.
5758

5859
### Configuring upstream VCS via Mission Portal
5960

26 KB
Loading

0 commit comments

Comments
 (0)