Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes in the readme for better readability #20

Merged
merged 1 commit into from
Oct 9, 2022
Merged

Changes in the readme for better readability #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Credentials Fetcher

Credentials-fetcher is a Linux daemon that retrieves gMSA credentials from Active Directory over LDAP. <br>
It creates and refreshes kerberos tickets from gMSA credentials. <br>
Kerberos tickets can be used by containers to run apps/services that authenticate using Active Directory.
`credentials-fetcher` is a Linux daemon that retrieves gMSA credentials from Active Directory over LDAP. It creates and refreshes kerberos tickets from gMSA credentials. Kerberos tickets can be used by containers to run apps/services that authenticate using Active Directory.

This daemon works in a similar way as ccg.exe and the gMSA plugin in Windows as described in - https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/manage-serviceaccounts#gmsa-architecture-and-improvements

Expand Down Expand Up @@ -32,7 +30,7 @@ For other linux distributions, the daemon binary needs to be built from source c

#### Standalone mode

To start a local dev environment from scratch.
To start a local dev environment from scratch:

```
* Clone the Git repository.
Expand All @@ -46,7 +44,7 @@ To start a local dev environment from scratch.
To communicate with the daemon over gRPC, install grpc-cli. For example
`sudo yum install grpc-cli`

##### AddkerberosLease API:
##### AddKerberosLease API:
Note: APIs use unix domain socket
```
Invoke the AddkerberosLease API with the credentialsspec input as shown:
Expand All @@ -64,7 +62,7 @@ AddKerberosLease "credspec_contents: '{\"CmsPlugins\":[\"ActiveDirectory\"],\"Do
created_kerberos_file_paths - Paths associated to the Kerberos tickets created corresponding to the gMSA accounts
```

##### DeletekerberosLease API:
##### DeleteKerberosLease API:

```
Invoke the Delete kerberosLease API with lease id input as shown:
Expand Down