Skip to content
Snippets Groups Projects
Commit ce3a9ab5 authored by Donghee Kang's avatar Donghee Kang
Browse files

Add python helper code for migration

parent b0573a95
No related branches found
No related tags found
No related merge requests found
# Migration
## Getting started
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://gitlab.kit.edu/kit/gitlab/migration.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.kit.edu/kit/gitlab/migration/-/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
Use the built-in continuous integration in GitLab.
- [ ] [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)
***
# 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!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
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.
## Name
Choose a self-explaining name for your project.
## 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.
## 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.
## 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.
## 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.
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.
## 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.
Useful migration tools
#!/usr/bin/env python3
import gitlab
import os
import sys
import urllib3
import json
import time
from tqdm import tqdm
"""
Disable ssl warning: suppresses ssl warning for disabling certificate check
"""
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
KIT_GITLAB_URL = "https://gitlab.kit.edu"
KIT_PILOT_URL = "https://git.scc.kit.edu"
KIT_GITLAB_TOKEN = "-------------------------" # Personal Access Token
KIT_PILOT_TOKEN = "=========================" # Personal Access Token
gl_kit = gitlab.Gitlab(KIT_GITLAB_URL, private_token=KIT_GITLAB_TOKEN, ssl_verify=False, api_version="4")
gl_pilot = gitlab.Gitlab(KIT_PILOT_URL, private_token=KIT_PILOT_TOKEN, ssl_verify=False, api_version="4")
##############################################################################################
# parameter
##############################################################################################
# source group id
group_id_in_source = 123456789 # required parameter
# In destination(gitlab.kit.edu), subgroup "migration" must be existing in advance
# If subgroup "migration" is not existing yet, please create it at the web interface first.
group_namespace_in_target = 'kit/scc/sys/gitlab/migration'
##############################################################################################
class migration():
def export_projects(self):
# To perform a new export, a group id must to be given.
if group_id_in_source is None:
print("Group ID is not provided, please find the group id from the source gitlab")
exit()
gl_pilot.auth()
current_working_directory = os.getcwd()
exported_file_directory = current_working_directory + "/exported_files"
group = gl_pilot.groups.get(group_id_in_source, lazy=True)
projects = group.projects.list(get_all=True, iterator=True)
for project in (project for project in projects if len(projects) > 0):
project_name = project.name.replace(' ', '-')
# Get the project object using project_id, project itself does not have exports function.
single_project = gl_pilot.projects.get(project.id)
project_export = single_project.exports.create()
# Wait for the 'finished' status of export, but python-gitlab version dependent!
#while project_export.export_status != 'finished':
# time.sleep(10)
# project_export.refresh()
# wait for the preparation shortly
time.sleep(3)
print("Start exporting process for project {} from the source GitLab >>> :^^: <<< ".format(project_name))
# Wait 10sec(small project) or 100sec(big project)
with tqdm(total=100, desc="Exporting {}".format(project_name), bar_format="{l_bar}{bar} [ time left: {remaining} ]") as pbar:
for i in range(100):
time.sleep(0.1) # 0.1 -> 10sec or 1 -> 100sec
pbar.update(1)
project_export.refresh()
# Download the result
print("Downloading project {} from the source GitLab, please wait while we download project ".format(project_name))
file_is = '{}/{}_export.tar.gz'.format(exported_file_directory, project_name)
with open(file_is, 'wb') as f:
project_export.download(streamed=True, action=f.write)
def import_projects(self):
gl_kit.auth()
current_working_directory = os.getcwd()
exported_file_directory = current_working_directory + "/exported_files"
# prepare the list of exported files under exported_file_directory
list_of_projects = []
list_of_files = os.listdir(exported_file_directory)
list_of_files.sort()
for project in list_of_files:
name_of_project = project.removesuffix("_export.tar.gz")
#name_of_project = project.strip("_export.tar.gz") # thjs does not work for a_export.tar.gz
list_of_projects.append(name_of_project)
# importing
for project_name in list_of_projects:
file_is = "{}/{}_export.tar.gz".format(exported_file_directory, project_name)
with open(file_is, 'rb') as f:
output = gl_kit.projects.import_project(
f,
path=project_name,
name=project_name.replace('-', ' '),
namespace=group_namespace_in_target,
override_params={'visibility': 'private'},
)
# Get a ProjectImport object to track the import status
project_import = gl_kit.projects.get(output['id'], lazy=True).imports.get()
while project_import.import_status != 'finished':
# Wait 10sec(small project) or 100sec(big project)
with tqdm(total=100, desc="Importing {}".format(project_name), bar_format="{l_bar}{bar} [ time left: {remaining} ]") as pbar:
for i in range(100):
time.sleep(0.1) # 0.1 -> 10sec or 1 -> 100sec
pbar.update(1)
project_import.refresh()
if __name__ == "__main__":
# let's start
migration_accessor = migration()
migration_accessor.export_projects()
migration_accessor.import_projects()
\ No newline at end of file
#!/usr/bin/env python3
import gitlab
import os
import sys
import urllib3
import json
import time
from tqdm import tqdm
"""
Disable ssl warning: suppresses ssl warning for disabling certificate check
"""
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
KIT_GITLAB_URL = "https://gitlab.kit.edu"
KIT_TOKEN = "--------------------------" # Personal Access Token
gl = gitlab.Gitlab(KIT_GITLAB_URL, private_token=KIT_TOKEN, ssl_verify=False, api_version="4")
gl.auth()
##############################################################################################
# parameter
##############################################################################################
# In destination(gitlab.kit.edu), subgroup "migration" must be existing in advance
# If subgroup "migration" is not existing yet, please create it at the web interface first.
group_namespace_in_target = 'kit/scc/sys/gitlab/migration'
# Exported files are already available in your local {PWD}/exported_file directory.
list_of_projects = ["my_project_1","my_project_2","my_project_3"]
##############################################################################################
class migration():
def import_projects(self):
current_working_directory = os.getcwd()
exported_file_directory = current_working_directory + "/exported_files"
for project_name in list_of_projects:
file_is = "{}/{}_export.tar.gz".format(exported_file_directory, project_name)
with open(file_is, 'rb') as f:
output = gl.projects.import_project(
f,
path=project_name,
name=project_name,
namespace=group_namespace_in_target,
override_params={'visibility': 'private'},
)
# wait for the preparation shortly
time.sleep(3)
print("Start importing process for project {} on target GitLab <<< :^^: >>> ".format(project_name))
# Get a ProjectImport object to track the import status
project_import = gl.projects.get(output['id'], lazy=True).imports.get()
while project_import.import_status != 'finished':
# Wait 10sec(small project) or 100sec(big project)
with tqdm(total=100, desc="Importing {}".format(project_name), bar_format="{l_bar}{bar} [ time left: {remaining} ]") as pbar:
for i in range(100):
time.sleep(0.1) # 0.1 -> 10sec or 1 -> 100sec
pbar.update(1)
project_import.refresh()
if __name__ == "__main__":
# let's start collecting project information
migration_accessor = migration()
migration_accessor.import_projects()
\ No newline at end of file
#!/usr/bin/env python3
import gitlab
import os
import sys
import urllib3
import json
import time
from tqdm import tqdm
"""
Disable ssl warning: suppresses ssl warning for disabling certificate check
"""
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
KIT_GITLAB_URL = "https://gitlab.kit.edu"
KIT_PILOT_URL = "https://git.scc.kit.edu"
KIT_GITLAB_TOKEN = "--------------------------" # Personal Access Token
KIT_PILOT_TOKEN = "==========================" # Personal Access Token
gl_kit = gitlab.Gitlab(KIT_GITLAB_URL, private_token=KIT_GITLAB_TOKEN, ssl_verify=False, api_version="4")
gl_kit.auth()
gl_pilot = gitlab.Gitlab(KIT_PILOT_URL, private_token=KIT_PILOT_TOKEN, ssl_verify=False, api_version="4")
gl_pilot.auth()
##############################################################################################
# parameter
##############################################################################################
project_id = None # None or 123456789
source_namespace = "dq1464/migration_project" # user needs to define project_namespace (optional)
target_namespace = "donghee.kang" # user needs to define user_namespace
##############################################################################################
class migration():
def export_import_project(self):
# parameter: project id has a higher priority
if project_id:
project_target = project_id
elif source_namespace:
project_target = source_namespace
else:
print("Please provide project_id or project_namespace from the source GtiLab")
# export
project = gl_pilot.projects.get(project_target)
project_export = project.exports.create()
# replace spaces with dash
project_name = project.name.replace(' ', '-')
# Wait for the 'finished' status of export, but python-gitlab version dependent!
#while project_export.export_status != 'finished':
# time.sleep(10)
# project_export.refresh()
# wait for the preparation shortly
time.sleep(3)
print("Start exporting process for project {} from the source GitLab >>> :^^: <<< ".format(project_name))
# Wait 10sec(small project) or 100sec(big project)
with tqdm(total=100, desc="Exporting {}".format(project_name), bar_format="{l_bar}{bar} [ time left: {remaining} ]") as pbar:
for i in range(100):
time.sleep(0.1) # 0.1 -> 10sec or 1 -> 100sec
pbar.update(1)
current_working_directory = os.getcwd()
exported_file_directory = current_working_directory + "/exported_files"
file_is = '{}/{}_export.tar.gz'.format(exported_file_directory, project_name)
# download
print("Downloading project {} from the source GitLab, please wait while we download project ".format(project_name))
with open(file_is, 'wb') as f:
project_export.download(streamed=True, action=f.write)
# importing
with open(file_is, 'rb') as f:
output = gl_kit.projects.import_project(
f,
path=project_name,
name=project.name,
namespace=target_namespace,
override_params={'visibility': 'private'},
)
# Get a ProjectImport object to track the import status
project_import = gl_kit.projects.get(output['id'], lazy=True).imports.get()
while project_import.import_status != 'finished':
# Wait 10sec(small project) or 100sec(big project)
with tqdm(total=100, desc="Importing {}".format(project_name), bar_format="{l_bar}{bar} [ time left: {remaining} ]") as pbar:
for i in range(100):
time.sleep(0.1) # 0.1 -> 10sec or 1 -> 100sec
pbar.update(1)
project_import.refresh()
if __name__ == "__main__":
# let's start
migration_accessor = migration()
migration_accessor.export_import_project()
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment