내용 작성

This commit is contained in:
정훈 변
2024-04-19 11:21:44 +09:00
parent 475bbb302b
commit b16fff6d64

177
README.md
View File

@@ -1,93 +1,146 @@
# teleport_role
# Teleport 권한 관리
권한 관리
참고 주소 : [https://goteleport.com/docs/access-controls/getting-started/](https://goteleport.com/docs/access-controls/getting-started/)
## Getting started
## Management > User Roles 에서 관리
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://lab.jhcloud.kr/sa_8001/teleport_role.git
git branch -M main
git push -uf origin main
```yaml
kind: role
metadata:
id: 1704266501288770282
name: datasaker
spec:
allow:
logins:
- dev2
node_labels:
ipaddr: '*'
deny:
logins:
- guest
node_labels:
group:
- prod-node
- prod-master
- proxy
options:
cert_format: standard
client_idle_timeout: 10m0s
create_db_user: false
create_desktop_user: false
desktop_clipboard: true
desktop_directory_sharing: true
enhanced_recording:
- command
- network
forward_agent: false
idp:
saml:
enabled: true
max_session_ttl: 8h0m0s
pin_source_ip: false
port_forwarding: true
record_session:
default: best_effort
desktop: true
ssh_file_copy: true
version: v5
```
## Integrate with your tools
현재 모든 사용자 계정에서 공통적으로 적용되는 2개의 Roles `datasaker` , `app-connect` 사용중
- [ ] [Set up project integrations](http://lab.jhcloud.kr/sa_8001/teleport_role/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## 허용
## Test and Deploy
```yaml
allow:
logins:
- dev2
node_labels:
ipaddr: '*'
```
Use the built-in continuous integration in GitLab.
`allow` 하위에 작성된 조건에 따라 허용이 가능
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
* `logins` : SSH 접속을 위해 사용할 User
* `node_labels` : 해당 label을 가진 서버 조회 가능
* `app_labels` : 해당 label을 가진 애플리케이션 조회 가능
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## 차단
## Suggestions for a good README
```yaml
deny:
logins:
- guest
node_labels:
group:
- prod-node
- prod-master
- proxy
```
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
`deny` 하위에 작성된 조건에 따라 차단 가능
## Name
Choose a self-explaining name for your project.
* `logins` : 작성한 User를 통한 접속 차단
* `node_labels` : 해당 label을 통해 특정 서버들 조회 및 접근 차단 가능
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
위 예는 group: prod-node , group: prod-master , group: proxy label 을 가진 서버 차단
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## 적용
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Management > Auth Connectors > EDIT CONNECTOR
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
```yaml
kind: github
metadata:
name: github_connector
spec:
api_endpoint_url: ""
client_id: 09a1dd5746d8b1727835
client_secret: 368294562e65f8cef49fed3c5781b6892be46087
display: GitHub
endpoint_url: ""
redirect_url: https://teleport.kr.datasaker.io/v1/webapi/github/callback
teams_to_logins: null
teams_to_roles:
- organization: CloudMOA
roles:
- app-connect
- datasaker
team: saas
- organization: CloudMOA
roles:
- datasaker
- app-connect
team: saas_teleport
version: v3
```
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
```yaml
- organization: CloudMOA
roles:
- datasaker
- app-connect
team: saas_teleport
```
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
해당 부분의 roles 부분에 작성하여 role 적용
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
`team` 같은 경우 Github의 Team 에서 조회 가능
![](https://t25540965.p.clickup-attachments.com/t25540965/74610a9b-bca5-49a2-a2db-698f93d4b0d9/%E1%84%89%E1%85%B3%E1%84%8F%E1%85%B3%E1%84%85%E1%85%B5%E1%86%AB%E1%84%89%E1%85%A3%E1%86%BA%202024-01-22%20%E1%84%8B%E1%85%A9%E1%84%92%E1%85%AE%203.08.13.png)
웹브라우저 상 주소의 맨 뒷 부분에 적혀있는 내용이 `team:` 에 입력되는 값 ex) saas